docs(native-page-transitions): improve docs

closes #1294
2025-02-21 00:23:00 +08:00 · 2017-03-29 18:56:15 -04:00 · 2017-03-29 18:56:15 -04:00 · 6ccf3a66bb
commit 6ccf3a66bb
parent 2b94ffdc44
1 changed files with 28 additions and 14 deletions
--- a/src/@ionic-native/plugins/native-page-transitions/index.ts
+++ b/src/@ionic-native/plugins/native-page-transitions/index.ts
@ -29,21 +29,35 @@ export interface NativeTransitionOptions {
 *
 * ...
 *
- * let options: NativeTransitionOptions = {
- *    direction: 'up',
- *    duration: 500,
- *    slowdownfactor: 3,
- *    slidePixels: 20,
- *    iosdelay: 100,
- *    androiddelay: 150,
- *    winphonedelay: 250,
- *    fixedPixelsTop: 0,
- *    fixedPixelsBottom: 60
- *  };
 *
- * this.nativePageTransitions.slide(options)
- *   .then(onSuccess)
- *   .catch(onError);
+ * // example of adding a transition when a page/modal closes
+ * ionViewWillLeave() {
+ *
+ *  let options: NativeTransitionOptions = {
+ *     direction: 'up',
+ *     duration: 500,
+ *     slowdownfactor: 3,
+ *     slidePixels: 20,
+ *     iosdelay: 100,
+ *     androiddelay: 150,
+ *     fixedPixelsTop: 0,
+ *     fixedPixelsBottom: 60
+ *    };
+ *
+ *  this.nativePageTransitions.slide(options)
+ *    .then(onSuccess)
+ *    .catch(onError);
+ *
+ * }
+ *
+ *
+ * // example of adding a transition when pushing a new page
+ * openPage(page: any) {
+ *
+ *   this.nativePageTransitions.slide(options);
+ *   this.navCtrl.push(page);
+ *
+ * }
 *
 * ```
 */