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

The documentation on type scripting nested navigation is unclear

Aberta
#960 2 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
324
Forks
2k
Métricas de merge de PRs
Nenhum PR com merge em 30d

Descrição

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

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela página de TypeScript sobre navegação aninhada e pela documentação separada sobre aninhamento de navigators vinculada na issue. Compare as estruturas dos navigators e use RootStackParamList e EditConversationModalNavigatorParamList informados como contexto de exemplo. Considera-se concluído quando a página de TypeScript inclui um exemplo completo e correspondente de um navigator raiz e de um navigator aninhado que explica onde NavigatorScreenParams deve ser usado.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
react-native, typescript
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
35/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.