react-navigation / react-navigation/react-navigation.github.io
Better documentation for router getScreenOptions
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
The documentation of getScreenOptions needs some clarification:
- the headline is
getScreenOptions(navigation, screenProps)but the text explains 3 parameters. What is about navigationOptions? - The text says "retrieve the navigation options for a screen". Why the function is named screen options while it returns navigation options?
- The example code uses
addNavigationHelperswhich does not exits anymore? - For me is not clear where I can use this function, p.ex. in screen, in my custom router, etc. Please improve the example to make this more clear.
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 liée de custom-routers, à la section getScreenOptions, et examinez sa signature, son explication et son exemple utilisant addNavigationHelpers. Clarifiez les paramètres, la terminologie, l’utilisation actuelle de l’API et l’endroit où la fonction est utilisée ; le travail est terminé lorsque l’exemple et le texte environnant répondent à chaque point sans dépendre d’API obsolètes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, react-native
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100