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

Documentation missing for canGoBack()

未关闭
#724 2 条评论 10 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
324
派生
2k
PR 合并指标
30 天内没有已合并 PR

描述

Current Behavior

According to @satya164 in react-navigation/react-navigation#7814 we should use canGoBack() to guard against going back too much. If we don't, it'll result in a console.error() being emitted (red screen).

canGoBack is an undocumented feature. It's only mentioned in passing in the 'upgrading from 3.x' article where it's mentioned as a feature on the HeaderBackButton, however the function is (also?) available on the navigator object.

Screen Shot 2020-03-18 at 11 36 36

Expected Behavior
Typing "canGoBack" in search field in the documentation should yield this result.

How to reproduce

  1. Open https://reactnavigation.org/docs
  2. Type "canGoBack" in upper right search field

** Other comments **

It may make sense to reference the new documentation for canGoBack() in relation to goBack(), pop(), jumpTo(), and popToTop().

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先在文档中搜索对 canGoBack()、goBack()、pop()、jumpTo() 和 popToTop() 的现有引用。添加一个可搜索的 canGoBack() 条目,说明其可用性和用于防护的目的,并附上相关导航方法的链接;完成的标准是,在文档中搜索 canGoBack 时会返回新的说明。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react, react-native
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
停滞
描述清晰度
基本清楚
新手友好度
45/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。