content: API reference for NavController provider

Open
#506 8 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
angular
Domain
documentation

Research direction

Start with the existing ion-nav API page and the NavController API exposed by @ionic/angular. Compare the documented ion-nav methods with navigateBack, navigateRoot, and navigateForward, then clarify the distinction and add the missing NavController method reference. Done means users can find these methods and understand which class they belong to.

Written by the indexing model from the issue text.

Description

content package: angular

Original issue by @PeterHdd on 2019-02-28T13:19:24Z

Documentation

I imported the following:

 `import { NavController } from '@ionic/angular';`

and when checking the methods I found that it contains: navigateBack, navigateRoot, and navigateForward.. but I can't find these methods in the documentation.

In the ion-nav api: https://ionicframework.com/docs/api/nav I found different methods, not sure if this is a different class other than navcontroller. I would appreciate if someone can just clear this to me.

Thank you!

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.