react-navigation / react-navigation/react-navigation.github.io
Better documentation for router getScreenOptions
Aperta
Nessuno ha ancora preso questa issue.
help wanted
- Lingua principale
- JavaScript
- Stelle
- 324
- Fork
- 2k
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
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.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla documentazione collegata di custom-routers, nella sezione getScreenOptions, e rivedi la relativa firma, spiegazione ed esempio con addNavigationHelpers. Chiarisci i parametri, la terminologia, l’uso corrente dell’API e dove viene utilizzata la funzione; il lavoro è completato quando l’esempio e il testo circostante rispondono a ogni punto senza fare affidamento su API obsolete.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, react-native
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100