react-navigation / react-navigation/react-navigation.github.io
Type checking nested navigator is missing StackParamList definition and usage
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 324
- Forks
- 2k
- PR merge metrics
- No merged PRs in 30d
Description
In the Nesting Navigators guide, the example given does not work with the stack structure provided in the page (which is not nested to begin with). I believe the author is implying a different nested stack (since the example is using StackParamList instead of RootStackParamList), but the definition for the StackParamList is not provided, confusing the reader into thinking it's the same as the RootStackParamList.
The definition of StackParamList and its usage should provided to give context to the nested examples.
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
Open versioned_docs/version-6.x/typescript.md and read the Nesting Navigators section alongside the stack structure shown on the page. Add the missing StackParamList definition and its usage so the nested example is consistent with the surrounding example and understandable without guessing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, react-native, typescript
- Domain
- documentation, mobile-dev
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 72/100