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

Documentation missing for canGoBack()

Offen
#724 2 Kommentare 10 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
324
Forks
2k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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().

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, in der Dokumentation nach den vorhandenen Verweisen auf canGoBack(), goBack(), pop(), jumpTo() und popToTop() zu suchen. Füge einen durchsuchbaren Eintrag zu canGoBack() hinzu, der seine Verfügbarkeit und seinen Zweck als Schutzprüfung erklärt, mit Links zu den zugehörigen Navigationsmethoden; als erledigt gilt die Aufgabe, wenn die Suche nach canGoBack in der Dokumentation die neue Erklärung zurückgibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react, react-native
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.