digitalfabrik/integreat-app

import { NavigationAction, useNavigation } from '@react-navigation/native'
import { useEffect } from 'react'

/**
 * Intercept and prevent the users back navigation and instead execute onBackNavigation if provided
 * @param onBackNavigation
 */
const useOnBackNavigation = (onBackNavigation?: (action: NavigationAction) => void): void => {
  const navigation = useNavigation()

  useEffect(
    () =>
      navigation.addListener('beforeRemove', event => {
        if (onBackNavigation) {
          event.preventDefault()
          onBackNavigation(event.data.action)
        }
      }),
    [navigation, onBackNavigation],
  )
}

export default useOnBackNavigation