components with animation prop should include or link to more information on AnimationBuilder

Open
#1,492 3 comments 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
Mostly clear
Activity status
Stale
Tech stack
angular
Domain
documentation

Research direction

Start with the linked ion-nav documentation page and inspect the animation property wording. Check the references to AnimationBuilder, @ionic/angular, and Dart to determine which information applies. Done when the page clearly identifies the relevant API and links to guidance for creating a custom ion-nav transition.

Written by the indexing model from the issue text.

Description

content

URL

https://ionicframework.com/docs/api/nav

What is missing or inaccurate about the content on this page?

The animation property of ion-nav says :

By default ion-nav animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using AnimateBuilder functions.

It's unclear what's "AnimateBuilder". I couldn't find any reference on that except in Dart ... maybe it's misspelled and it was AnimationBuilder of Angular ? Or maybe Animation and AnimationController from @ionic/angular ? I'm looking to override the animation to make the ion-nav slide in.

Thanks

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.