react-navigation / react-navigation/react-navigation.github.io
The documentation on type scripting nested navigation is unclear
還沒有人認領這個 Issue。
- 主要語言
- JavaScript
- 星號
- 324
- 分支
- 2k
- PR 合併指標
- 30 天內沒有已合併 PR
描述
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 |
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
研究方向
從 TypeScript 巢狀導覽頁面和 issue 中連結的獨立 navigator 巢狀文件開始。比較它們的 navigator 結構,並使用所回報的 RootStackParamList 和 EditConversationModalNavigatorParamList 作為範例脈絡。完成的標準是 TypeScript 頁面包含一個完整且相符的 root navigator 和 nested navigator 範例,並說明 NavigatorScreenParams 應該放在哪裡。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- react-native, typescript
- 領域
- documentation
- Issue 類型
- 文件
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 活躍度
- 停滯
- 描述清晰度
- 描述清楚
- 新手友好度
- 35/100