docs(navController): add docs for navOptions

This commit is contained in:
Mike Hartington
2016-05-09 10:48:40 -04:00
parent 6331ec4b26
commit 4fa2ce7fa3

View File

@ -139,6 +139,20 @@ import {ViewController} from './view-controller';
* });
* ```
*
* ## NavOptions
*
* Some methods on `NavController` allow for customizing the current transition.
* To do this, we can pass an object with the modified properites.
*
* | Property | Value | Description |
* |-----------|-----------|------------------------------------------------------|
* | animate | `boolean` | Whether or not the transition should animate |
* | animation | `string` | What kind of animation should be used |
* | direction | `string` | The direction the page should animate |
* | duration | `number` | The length in milliseconds the animation should take |
* | easing | `string` | The easing for the animation |
*
*
* @see {@link /docs/v2/components#navigation Navigation Component Docs}
*/
export class NavController extends Ion {