react-navigation / react-navigation/react-navigation.github.io
Better documentation for router getScreenOptions
Aberta
Ninguém assumiu esta issue ainda.
help wanted
- Linguagem predominante
- JavaScript
- Estrelas
- 324
- Forks
- 2k
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
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.
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 vinculada de custom-routers, na seção getScreenOptions, e revise sua assinatura, explicação e exemplo usando addNavigationHelpers. Esclareça os parâmetros, a terminologia, o uso atual da API e onde a função é usada; considera-se concluído quando o exemplo e o texto ao redor respondem a cada ponto sem depender de APIs obsoletas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- javascript, react-native
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100