React Navigation needs a mention of useIonRouter

Open
#2,494 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
react
Domain
documentation

Research direction

Start with the React navigation page at https://ionicframework.com/docs/react/navigation and compare its coverage with the linked Vue router documentation. Add a clear mention of useIonRouter for Ionic React, including its relevance to choosing an animation direction; the page should make this usage discoverable without following RouterDirection references.

Written by the indexing model from the issue text.

Description

content package: react

URL
https://ionicframework.com/docs/react/navigation

What is missing or inaccurate about the content on this page?
I've looked all over the docs, and I haven't been able to find a single mention of using useIonRouter within Ionic React.

I was trying to navigate to a page and specify the direction of the animation, and the only way I ended up finding useIonRouter was by following usage of the RouterDirection type.

Sure enough the import is mentioned in @ionic/vue, but it doesn't exist for React.

Dominant language
MDX
Stars
621
Forks
3.2k
Avg merge
1d 2h
Merged PRs (30d)
86

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ionic-team/ionic-docs

All issues in ionic-team/ionic-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.