react-navigation / react-navigation/react-navigation.github.io
Clarify StackNavigator inside DrawerNavigator gotchas
Personne n'a encore pris cette issue.
- Langage dominant
- JavaScript
- Étoiles
- 324
- Forks
- 2k
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par la documentation de DrawerNavigator et du StackNavigator imbriqué, puis examinez l’Expo Snack lié et le push 2.0 référencé afin de déterminer si le comportement s’applique toujours. Mettez à jour la documentation concernée pour expliquer le problème des noms de route dupliqués et le modèle d’imbrication, avec l’exemple ou la reproduction actuels montrant ce qui est documenté comme étant terminé.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, react, react-native
- Domaine
- documentation, mobile-dev
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 30/100