react-navigation / react-navigation/react-navigation.github.io
Better documentation for router getScreenOptions
未关闭
还没有人认领这个 Issue。
help wanted
- 主要语言
- JavaScript
- 星标
- 324
- 派生
- 2k
- PR 合并指标
- 30 天内没有已合并 PR
描述
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.
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从链接的 custom-routers 文档中的 getScreenOptions 部分开始,检查其签名、说明以及使用 addNavigationHelpers 的示例。明确参数、术语、当前 API 的用法以及该函数的使用位置;当示例和周围文本能够回答每一点,且不依赖过时的 API 时,即表示完成。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- javascript, react-native
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 45/100