Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: useNavigation hook is required with static api #1277

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: useNavigation hook is required with static api #1277

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5abfb1c
docs: useNavigation hook is required with static api
Johan-dutoit Oct 5, 2023
ea1afa9
Add useNavigation to example
Johan-dutoit Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion versioned_docs/version-7.x/static-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ The same principles apply to the static API as the dynamic API. We have navigato
```js
import * as React from 'react';
import { View, Text } from 'react-native';
import { createStaticNavigation } from '@react-navigation/native';
import { createStaticNavigation, useNavigation } from '@react-navigation/native';
import { createNativeStackNavigator } from '@react-navigation/native-stack';

function HomeScreen() {
const navigation = useNavigation();

return (
<View style={{ flex: 1, alignItems: 'center', justifyContent: 'center' }}>
<Text>Home Screen</Text>
Expand Down Expand Up @@ -177,5 +179,6 @@ The static API is a convenience wrapper around the dynamic API, not a full-repla

- The navigation tree is static with the static API, i.e. the configuration can't be changed dynamically (e.g. updating list of screens or options based on external data).
- The static configuration doesn't have access to context or props, so you can't use them in options, listeners etc. specified in the static configuration.
- The navigation object is no longer passed to your screens and you'll need to use the `useNavigation()` hook

The dynamic API is still the primary API and isn't going away. So we recommend to avoid rewriting your app to use the static API if you have type-checking and deep linking setup already. Instead, consider using the static API in new projects where you know you won't need to change the configuration dynamically.