From 4fa2ce7fa3922d025cd33a0fcd82587c1f4dbcd8 Mon Sep 17 00:00:00 2001 From: Mike Hartington Date: Mon, 9 May 2016 10:48:40 -0400 Subject: [PATCH] docs(navController): add docs for navOptions --- ionic/components/nav/nav-controller.ts | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/ionic/components/nav/nav-controller.ts b/ionic/components/nav/nav-controller.ts index e469126381..62f88435cc 100644 --- a/ionic/components/nav/nav-controller.ts +++ b/ionic/components/nav/nav-controller.ts @@ -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 {