react-navigation / react-navigation/react-navigation.github.io

The documentation on type scripting nested navigation is unclear

オープン
#960 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
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

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

TypeScript のネストされたナビゲーションのページと、issue にリンクされている別の navigator のネストに関するドキュメントから始めます。それらの navigator 構造を比較し、報告されている RootStackParamList と EditConversationModalNavigatorParamList を例のコンテキストとして使用します。完了の条件は、TypeScript のページに、NavigatorScreenParams をどこに配置するかを説明する、対応する root navigator と nested navigator の完全な例が含まれていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
react-native, typescript
領域
documentation
issue の種類
ドキュメント
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。