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

Better documentation for router getScreenOptions

Đang mở
#319 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

help wanted
Ngôn ngữ chính
JavaScript
Star
324
Fork
2k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu với tài liệu custom-routers được liên kết, tại phần getScreenOptions, và xem lại chữ ký, phần giải thích cũng như ví dụ sử dụng addNavigationHelpers. Làm rõ các tham số, thuật ngữ, cách sử dụng API hiện tại và nơi hàm được sử dụng; được xem là hoàn tất khi ví dụ và phần văn bản xung quanh trả lời được từng điểm mà không dựa vào các API đã lỗi thời.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript, react-native
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.