React Navigation Hooks
🏄♀️ Surfing the wave of React Hook hype with a few convenience hooks for @react-navigation/core
v3/v4. Destined to work on web, server, and React Native. Contributions welcome!
IMPORTANT: react-navigation v5 is already on its way and is a full rewrite (including hooks). This project will not live past v4, and will try to make the migration path from v4 to v5 easy by not introducing any new hook that won't be in v5.
Examples (web only so far)
See an example web app which uses react-navigation and hooks on the client and the server:
https://github.com/react-navigation/web-server-example
Docs
yarn add react-navigation-hooks
import * from 'react-navigation-hooks'
useNavigation()
This is the main convenience hook. It provides the regular navigation prop, as you'd get via the screen prop or by using withNavigation
.
You can use the navigate functionality anywhere in your app:
{ // be careful to never call useNavigation in the press callback. Call hooks directly from the render function! const navigate = ; return <Button onPress= { ; } title="Go Home" /> ;}
useNavigationParam(paramName)
Access a param for the current navigation state
{ const name = ; return <p>name is name</p>;}
Literally the same as useNavigation().getParam(paramName)
useNavigationState()
Access the navigation state of the current route, or if you're in a navigator view, access the navigation state of your sub-tree.
{ const routeName = ; return <p>My route name is routeName</p>;}
Literally the same as useNavigation().state
useNavigationKey()
Convenient way to access the key of the current route.
Literally the same as useNavigationState().key
useNavigationEvents(handler)
Subscribe to navigation events in the current route context.
{ const events setEvents = ; ; // evt.type is [will/did][Focus/Blur] return <> events </> ;}
The event payload will be the same as provided by addListener
, as documented here: https://reactnavigation.org/docs/en/navigation-prop.html#addlistener-subscribe-to-updates-to-navigation-lifecycle
useIsFocused()
Convenient way to know if the screen currently has focus.
{ const isFocused = ; return <Text>isFocused ? 'Focused' : 'Not Focused'</Text>;}
useFocusEffect(callback)
Permit to execute an effect when the screen takes focus, and cleanup the effect when the screen loses focus.
{ ; return <View>...</View>;}
NOTE: To avoid the running the effect too often, it's important to wrap the callback in useCallback before passing it to useFocusEffect
as shown in the example. The effect will re-execute everytime the callback changes if the screen is focused.
useFocusEffect
can be helpful to refetch some screen data on params changes:
{ const user setUser = React; const fetchUser = React; ; return <ProfileContent user=user />;}
useFocusEffect
can be helpful to handle hardware back behavior on currently focused screen:
const useBackHandler = boolean ;;
useFocusState()
deprecated: this hook does not exist in v5, you should rather use useIsFocused
Convenient way of subscribing to events and observing focus state of the current screen.
{ const focusState = ; return <Text>focusStateisFocused ? 'Focused' : 'Not Focused'</Text>;}
One (always, and only one) of the following values will be true in the focus state:
- isFocused
- isBlurring
- isBlurred
- isFocusing