react-navigation / react-navigation/react-navigation.github.io
Clarify StackNavigator inside DrawerNavigator gotchas
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
Moved from https://github.com/react-navigation/react-navigation/issues/3890
Using multiple Navigators inside a DrawerNavigator, where the subnavigators shared a route name, led to unexpected (undocumented) behavior
| software | version |
|---|---|
| react-navigation | 1.5.9 |
| react-native | expo@26 |
Context
I was an early user of @expo/ex-navigation, and have recently been upgrading to react-navigation. I came across some faults in either the DrawerNavigation documentation or in the general mental framework of react-navigation.
Current Behavior
When nesting navigators inside a DrawerNavigator, duplicated route names behave unexpectedly (in my mental model).
Expo Snack repro
const WidgetStack = StackNavigator({
Widget: {
screen: WidgetScreen,
},
// This is very easy to get wrong, it is not clear in the Drawer documentation
// that this route name should be distinct.
Settings: {
screen: SettingsScreen,
},
});
const SettingsStack = StackNavigator({
Settings: {
screen: SettingsScreen,
},
});
const DrawerApp = DrawerNavigator({
Widget: {
screen: WidgetStack,
},
Settings: {
screen: SettingsStack,
},
}, {
initialRouteName: 'Widget',
});
When tapping on the "Settings" drawer item, I expected the currently selected "tab" in the drawer to be "Settings", I expected no routes to be "pushed" onto my stack navigator. Instead, the "widget" tab stays selected, and a settings route is pushed onto the WidgetStack.
There were no pieces of documentation to warn me of this behavior, and it was actually very difficult to even tell this is what was happening (it was much easier when I decided to build the minimal repro).
My current mental model
My mental model for react-navigation was previously that each nested navigator was a "subtree". With that model, I saw no issue with a duplicated route name.
DrawerApp
/ \
WidgetStack SettingsStack
| | |
/ \ Settings
Widget Settings
I'm not here to debate whether this is the correct model, but a simple piece of documentation would have saved me about an entire day :(
I would be happy to submit a PR to address this, but it appears with the 2.0 push, this might be out of date, and furthermore - I am not sure if my current model is correct enough to even write docs.
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pela documentação de DrawerNavigator e do StackNavigator aninhado; em seguida, revise o Expo Snack vinculado e o push 2.0 referenciado para determinar se o comportamento ainda se aplica. Atualize a documentação relevante para explicar o problema dos nomes de rota duplicados e o modelo de aninhamento, com o exemplo ou a reprodução atuais mostrando o que está documentado como concluído.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript, react, react-native
- Domínio
- documentation, mobile-dev
- Tipo de issue
- Documentação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 30/100