react-navigation / react-navigation/react-navigation.github.io

Better documentation for router getScreenOptions

未關閉
#319 1 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 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 addNavigationHelpers which 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.

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從連結的 custom-routers 文件中的 getScreenOptions 區段開始,檢視其簽章、說明以及使用 addNavigationHelpers 的範例。釐清參數、術語、目前 API 的用法,以及該函式的使用位置;當範例和周圍文字能回答每一點,且不依賴過時的 API 時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript, react-native
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
停滯
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。