react-navigation / react-navigation/react-navigation.github.io
The documentation on type scripting nested navigation is unclear
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 324
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
Description
Current Behavior
- What code are you running and what is happening?
- Include a screenshot or video if it makes sense.
I'm trying to setup typescript for navigating into a nested navigator. From reading the doc, this was my attempt (which I'm assuming is wrong. It gives me''Create Conversation modal'' is referenced directly or indirectly in its own type annotation.ts(2502.
export type RootStackParamList = {
Home: undefined;
SignInUpTunnel: undefined;
'Create Conversation modal': NavigatorScreenParams<EditConversationModalNavigatorParamList>; <==== typescript error here
};
...
return
<AuthenticatedUserProvider>
<Stack.Navigator screenOptions={{ headerShown: false }} mode="modal">
<Stack.Screen name="Home" component={HomeDrawerNavigator} />
<Stack.Screen name="Create Conversation modal" component={EditConversationModalNavigator} />
</Stack.Navigator>
</AuthenticatedUserProvider>
...
export type EditConversationModalNavigatorParamList = RootStackParamList & {
'Create conversation': { userToInvite: UserConversationStatusCellData | null };
};
...
navigation.navigate('Create Conversation modal', { screen: 'Create conversation', params: { userToInvite } });
Unfortunately, the documentation on this topic is very thin: https://reactnavigation.org/docs/typescript#type-checking-screens-and-params-in-nested-navigator.
Also, the documentation uses a different navigation structure than the documentation for nesting navigators. making it hard to know where to actually put the NavigatorScreenParams and what paramList to give it.
Expected Behavior
I would expect the documentation for the typescripting of a nested navigator to include a full example (with the root navigator and nested navigator) and I would expect it to use the same navigators as the documentation to nest navigator.
How to reproduce
- You must provide a way to reproduce the problem. If you are having an issue with your machine or build tools, the issue belongs on another repository as that is outside of the scope of React Navigation.
- Either re-create the bug on Snack or link to a GitHub repository with code that reproduces the bug.
- Explain how to run the example app and any steps that we need to take to reproduce the issue from the example app.
- Keep the repro code as simple as possible, with the minimum amount of code required to repro the issue.
- Before reporting an issue, make sure you are on the latest version of the package.
Your Environment
| software | version |
|---|---|
| typescript 4.0.7 | |
| @react-navigation/native 5.9.3 | |
| react-native | |
| expo 40 | |
| node 14.6.0 | |
| npm or yarn 1.22.10 |
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the TypeScript nested-navigation page and the separate navigator-nesting documentation linked in the issue. Compare their navigator structures and use the reported RootStackParamList and EditConversationModalNavigatorParamList as the example context. Done means the TypeScript page includes a complete matching root and nested navigator example that explains where NavigatorScreenParams belongs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react-native, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100