feat(viewcontroller): add onWillDismiss callback

manucorporat · adamdbradley · commit ec99bfd01945 · 2016-06-30T08:06:19.000-05:00
Fixed #6702
diff --git a/demos/toast/index.ts b/demos/toast/index.ts
@@ -16,7 +16,7 @@ class ApiDemoPage {
       duration: 3000
     });
 
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
@@ -26,7 +26,7 @@ class ApiDemoPage {
       duration: 3000
     });
 
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
@@ -35,7 +35,7 @@ class ApiDemoPage {
       message: 'I am dismissed after 1.5 seconds',
       duration: 1500
     });
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
@@ -45,12 +45,12 @@ class ApiDemoPage {
       showCloseButton: true,
       closeButtonText: 'Ok'
     });
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
   private dismissHandler() {
-    console.info('Toast onDismiss()');
+    console.info('Toast onDidDismiss()');
   }
 
 }
diff --git a/src/components/alert/test/basic/index.ts b/src/components/alert/test/basic/index.ts
@@ -136,8 +136,8 @@ class E2EPage {
       this.testPromptOpen = true;
     });
 
-    alert.onDismiss((data: any, role: any) => {
-      console.log('onDismiss, data:', data, 'role:', role);
+    alert.onDidDismiss((data: any, role: any) => {
+      console.log('onDidDismiss, data:', data, 'role:', role);
     });
   }
 
diff --git a/src/components/alert/test/dismiss/index.ts b/src/components/alert/test/dismiss/index.ts
@@ -24,7 +24,7 @@ export class E2EPage {
       ]
     });
 
-    alert.onDismiss(() => {
+    alert.onDidDismiss(() => {
       console.log('dismiss');
       this.nav.push(AnotherPage);
     });
diff --git a/src/components/datetime/datetime.ts b/src/components/datetime/datetime.ts
@@ -489,7 +489,7 @@ export class DateTime {
     picker.present(pickerOptions);
 
     this._isOpen = true;
-    picker.onDismiss(() => {
+    picker.onDidDismiss(() => {
       this._isOpen = false;
     });
   }
diff --git a/src/components/loading/loading.ts b/src/components/loading/loading.ts
@@ -85,7 +85,7 @@ export class Loading extends ViewController {
  * will show even during page changes, but this can be disabled by setting
  * `dismissOnPageChange` to `true`. To dismiss the loading indicator after
  * creation, call the `dismiss()` method on the Loading instance. The
- * `onDismiss` function can be called to perform an action after the loading
+ * `onDidDismiss` function can be called to perform an action after the loading
  * indicator is dismissed.
  *
  * >Note that after the component is dismissed, it will not be usable anymore
@@ -126,7 +126,7 @@ export class Loading extends ViewController {
  *     duration: 5000
  *   });
  *
- *   loading.onDismiss(() => {
+ *   loading.onDidDismiss(() => {
  *     console.log('Dismissed loading');
  *   });
  *
diff --git a/src/components/loading/test/basic/index.ts b/src/components/loading/test/basic/index.ts
@@ -15,7 +15,7 @@ class E2EPage {
       cssClass: 'my-custom-loader'
     });
 
-    loading.onDismiss(() => {
+    loading.onDidDismiss(() => {
      console.log('Dismissed loading');
     });
 
diff --git a/src/components/modal/modal.ts b/src/components/modal/modal.ts
@@ -145,7 +145,7 @@ export class Modal extends ViewController {
  *
  *  presentProfileModal() {
  *    let profileModal = this.modalCtrl.create(Profile, { userId: 8675309 });
- *    profileModal.onDismiss(data => {
+ *    profileModal.onDidDismiss(data => {
  *      console.log(data);
  *    });
  *    profileModal.present();
diff --git a/src/components/modal/test/basic/index.ts b/src/components/modal/test/basic/index.ts
@@ -36,8 +36,13 @@ class E2EPage {
     let modal = this.modalCtrl.create(ModalPassData, { userId: 8675309 });
     modal.present();
 
-    modal.onDismiss((data: any) => {
+    modal.onWillDismiss((data: any) => {
+      console.log('WILL DISMISS with data', data);
+      console.timeEnd('modal');
+    });
+    modal.onDidDismiss((data: any) => {
       console.log('modal data', data);
+      console.timeEnd('modal');
     });
   }
 
@@ -56,7 +61,7 @@ class E2EPage {
 
   presentModalWithInputs() {
 	  let modal = this.modalCtrl.create(ModalWithInputs);
-    modal.onDismiss((data: any) => {
+    modal.onDidDismiss((data: any) => {
       console.log('Modal with inputs data:', data);
     });
     modal.present();
@@ -153,27 +158,28 @@ class ModalPassData {
   }
 
   submit() {
+    console.time('modal');
     this.viewCtrl.dismiss(this.data);
   }
 
   ionViewLoaded(){
-    console.log("ModalPassData ionViewLoaded fired");
+    console.log('ModalPassData ionViewLoaded fired');
   }
 
   ionViewWillEnter(){
-    console.log("ModalPassData ionViewWillEnter fired");
+    console.log('ModalPassData ionViewWillEnter fired');
   }
 
   ionViewDidEnter(){
-    console.log("ModalPassData ionViewDidEnter fired");
+    console.log('ModalPassData ionViewDidEnter fired');
   }
 
   ionViewWillLeave(){
-    console.log("ModalPassData ionViewWillLeave fired");
+    console.log('ModalPassData ionViewWillLeave fired');
   }
 
   ionViewDidLeave(){
-    console.log("ModalPassData ionViewDidLeave fired");
+    console.log('ModalPassData ionViewDidLeave fired');
   }
 }
 
@@ -365,15 +371,15 @@ class ModalFirstPage {
   }
 
   ionViewLoaded(){
-    console.log("ModalFirstPage ionViewLoaded fired");
+    console.log('ModalFirstPage ionViewLoaded fired');
   }
 
   ionViewWillEnter(){
-    console.log("ModalFirstPage ionViewWillEnter fired");
+    console.log('ModalFirstPage ionViewWillEnter fired');
   }
 
   ionViewDidEnter(){
-    console.log("ModalFirstPage ionViewDidEnter fired");
+    console.log('ModalFirstPage ionViewDidEnter fired');
   }
 
   openActionSheet() {
@@ -446,15 +452,15 @@ class ModalSecondPage {
   }
 
   ionViewLoaded(){
-    console.log("ModalSecondPage ionViewLoaded");
+    console.log('ModalSecondPage ionViewLoaded');
   }
 
   ionViewWillEnter(){
-    console.log("ModalSecondPage ionViewWillEnter");
+    console.log('ModalSecondPage ionViewWillEnter');
   }
 
   ionViewDidEnter(){
-    console.log("ModalSecondPage ionViewDidEnter");
+    console.log('ModalSecondPage ionViewDidEnter');
   }
 }
 
diff --git a/src/components/nav/view-controller.ts b/src/components/nav/view-controller.ts
@@ -36,7 +36,8 @@ export class ViewController {
   private _leavingOpts: NavOptions = null;
   private _loaded: boolean = false;
   private _nbDir: Navbar;
-  private _onDismiss: Function = null;
+  private _onDidDismiss: Function = null;
+  private _onWillDismiss: Function = null;
   private _pgRef: ElementRef;
   private _cd: ChangeDetectorRef;
   protected _nav: NavController;
@@ -120,16 +121,33 @@ export class ViewController {
    * @private
    */
   onDismiss(callback: Function) {
-    this._onDismiss = callback;
+    // deprecated warning: added beta.11 2016-06-30
+    console.warn('onDismiss(..) has been deprecated. Please use onDidDismiss(..) instead');
+    this.onDidDismiss(callback);
+  }
+
+  /**
+   * @private
+   */
+  onDidDismiss(callback: Function) {
+    this._onDidDismiss = callback;
+  }
+
+  /**
+   * @private
+   */
+  onWillDismiss(callback: Function) {
+    this._onWillDismiss = callback;
   }
 
   /**
    * @private
    */
   dismiss(data?: any, role?: any, navOptions: NavOptions = {}) {
     let options = merge({}, this._leavingOpts, navOptions);
+    this._onWillDismiss && this._onWillDismiss(data, role);
     return this._nav.remove(this._nav.indexOf(this), 1, options).then(() => {
-      this._onDismiss && this._onDismiss(data, role);
+      this._onDidDismiss && this._onDidDismiss(data, role);
       return data;
     });
   }
diff --git a/src/components/popover/popover.ts b/src/components/popover/popover.ts
@@ -87,7 +87,7 @@ export class Popover extends ViewController {
  * To dismiss the popover after creation, call the `dismiss()` method on the
  * `Popover` instance. The popover can also be dismissed from within the popover's
  * view by calling the `dismiss()` method on the [ViewController](../../nav/ViewController).
- * The `onDismiss` function can be called to perform an action after the popover
+ * The `onDidDismiss` function can be called to perform an action after the popover
  * is dismissed. The popover will dismiss when the backdrop is clicked, but this
  * can be disabled by setting `enableBackdropDismiss` to `false` in the popover
  * options.
diff --git a/src/components/select/select.ts b/src/components/select/select.ts
@@ -320,7 +320,7 @@ export class Select {
     overlay.present(alertOptions);
 
     this._isOpen = true;
-    overlay.onDismiss(() => {
+    overlay.onDidDismiss(() => {
       this._isOpen = false;
     });
   }
diff --git a/src/components/toast/test/basic/index.ts b/src/components/toast/test/basic/index.ts
@@ -29,7 +29,7 @@ class E2EPage {
       message: 'User was created successfully'
     });
 
-    toast.onDismiss(() => {
+    toast.onDidDismiss(() => {
       console.log('Dismissed toast');
     });
 
@@ -50,7 +50,7 @@ class E2EPage {
       duration: 5000
     });
 
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
@@ -59,7 +59,7 @@ class E2EPage {
       message: 'I am dismissed after 1.5 seconds',
       duration: 1500
     });
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
@@ -70,12 +70,12 @@ class E2EPage {
       closeButtonText: 'Ok',
       position: positionString
     });
-    toast.onDismiss(this.dismissHandler);
+    toast.onDidDismiss(this.dismissHandler);
     toast.present();
   }
 
   private dismissHandler(toast: Toast) {
-    console.info('Toast onDismiss()');
+    console.info('Toast onDidDismiss()');
   }
 
 }
diff --git a/src/components/toast/toast.ts b/src/components/toast/toast.ts
@@ -103,7 +103,7 @@ export class Toast extends ViewController {
  * by passing the number of milliseconds to display it in the `duration` of
  * the toast options. If `showCloseButton` is set to true, then the close button
  * will dismiss the toast. To dismiss the toast after creation, call the `dismiss()`
- * method on the Toast instance. The `onDismiss` function can be called to perform an action after the toast
+ * method on the Toast instance. The `onDidDismiss` function can be called to perform an action after the toast
  * is dismissed.
  *
  * @usage
@@ -119,7 +119,7 @@ export class Toast extends ViewController {
  *     position: 'top'
  *   });
  *
- *   toast.onDismiss(() => {
+ *   toast.onDidDismiss(() => {
  *     console.log('Dismissed toast');
  *   });
  *

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class ApiDemoPage {`
`16`	`16`	`duration: 3000`
`17`	`17`	`});`
`18`	`18`
`19`		`- toast.onDismiss(this.dismissHandler);`
	`19`	`+ toast.onDidDismiss(this.dismissHandler);`
`20`	`20`	`toast.present();`
`21`	`21`	`}`
`22`	`22`
`@@ -26,7 +26,7 @@ class ApiDemoPage {`
`26`	`26`	`duration: 3000`
`27`	`27`	`});`
`28`	`28`
`29`		`- toast.onDismiss(this.dismissHandler);`
	`29`	`+ toast.onDidDismiss(this.dismissHandler);`
`30`	`30`	`toast.present();`
`31`	`31`	`}`
`32`	`32`
`@@ -35,7 +35,7 @@ class ApiDemoPage {`
`35`	`35`	`message: 'I am dismissed after 1.5 seconds',`
`36`	`36`	`duration: 1500`
`37`	`37`	`});`
`38`		`- toast.onDismiss(this.dismissHandler);`
	`38`	`+ toast.onDidDismiss(this.dismissHandler);`
`39`	`39`	`toast.present();`
`40`	`40`	`}`
`41`	`41`
`@@ -45,12 +45,12 @@ class ApiDemoPage {`
`45`	`45`	`showCloseButton: true,`
`46`	`46`	`closeButtonText: 'Ok'`
`47`	`47`	`});`
`48`		`- toast.onDismiss(this.dismissHandler);`
	`48`	`+ toast.onDidDismiss(this.dismissHandler);`
`49`	`49`	`toast.present();`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`private dismissHandler() {`
`53`		`- console.info('Toast onDismiss()');`
	`53`	`+ console.info('Toast onDidDismiss()');`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -136,8 +136,8 @@ class E2EPage {`
`136`	`136`	`this.testPromptOpen = true;`
`137`	`137`	`});`
`138`	`138`
`139`		`- alert.onDismiss((data: any, role: any) => {`
`140`		`- console.log('onDismiss, data:', data, 'role:', role);`
	`139`	`+ alert.onDidDismiss((data: any, role: any) => {`
	`140`	`+ console.log('onDidDismiss, data:', data, 'role:', role);`
`141`	`141`	`});`
`142`	`142`	`}`
`143`	`143`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ export class E2EPage {`
`24`	`24`	`]`
`25`	`25`	`});`
`26`	`26`
`27`		`- alert.onDismiss(() => {`
	`27`	`+ alert.onDidDismiss(() => {`
`28`	`28`	`console.log('dismiss');`
`29`	`29`	`this.nav.push(AnotherPage);`
`30`	`30`	`});`
Original file line number	Diff line number	Diff line change
`@@ -489,7 +489,7 @@ export class DateTime {`
`489`	`489`	`picker.present(pickerOptions);`
`490`	`490`
`491`	`491`	`this._isOpen = true;`
`492`		`- picker.onDismiss(() => {`
	`492`	`+ picker.onDidDismiss(() => {`
`493`	`493`	`this._isOpen = false;`
`494`	`494`	`});`
`495`	`495`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ export class Loading extends ViewController {`
`85`	`85`	`* will show even during page changes, but this can be disabled by setting`
`86`	`86`	* `dismissOnPageChange` to `true`. To dismiss the loading indicator after
`87`	`87`	* creation, call the `dismiss()` method on the Loading instance. The
`88`		- * `onDismiss` function can be called to perform an action after the loading
	`88`	+ * `onDidDismiss` function can be called to perform an action after the loading
`89`	`89`	`* indicator is dismissed.`
`90`	`90`	`*`
`91`	`91`	`* >Note that after the component is dismissed, it will not be usable anymore`
`@@ -126,7 +126,7 @@ export class Loading extends ViewController {`
`126`	`126`	`* duration: 5000`
`127`	`127`	`* });`
`128`	`128`	`*`
`129`		`- * loading.onDismiss(() => {`
	`129`	`+ * loading.onDidDismiss(() => {`
`130`	`130`	`* console.log('Dismissed loading');`
`131`	`131`	`* });`
`132`	`132`	`*`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ export class Modal extends ViewController {`
`145`	`145`	`*`
`146`	`146`	`* presentProfileModal() {`
`147`	`147`	`* let profileModal = this.modalCtrl.create(Profile, { userId: 8675309 });`
`148`		`- * profileModal.onDismiss(data => {`
	`148`	`+ * profileModal.onDidDismiss(data => {`
`149`	`149`	`* console.log(data);`
`150`	`150`	`* });`
`151`	`151`	`* profileModal.present();`
Original file line number	Diff line number	Diff line change
`@@ -36,8 +36,13 @@ class E2EPage {`
`36`	`36`	`let modal = this.modalCtrl.create(ModalPassData, { userId: 8675309 });`
`37`	`37`	`modal.present();`
`38`	`38`
`39`		`- modal.onDismiss((data: any) => {`
	`39`	`+ modal.onWillDismiss((data: any) => {`
	`40`	`+ console.log('WILL DISMISS with data', data);`
	`41`	`+ console.timeEnd('modal');`
	`42`	`+ });`
	`43`	`+ modal.onDidDismiss((data: any) => {`
`40`	`44`	`console.log('modal data', data);`
	`45`	`+ console.timeEnd('modal');`
`41`	`46`	`});`
`42`	`47`	`}`
`43`	`48`
`@@ -56,7 +61,7 @@ class E2EPage {`
`56`	`61`
`57`	`62`	`presentModalWithInputs() {`
`58`	`63`	`let modal = this.modalCtrl.create(ModalWithInputs);`
`59`		`- modal.onDismiss((data: any) => {`
	`64`	`+ modal.onDidDismiss((data: any) => {`
`60`	`65`	`console.log('Modal with inputs data:', data);`
`61`	`66`	`});`
`62`	`67`	`modal.present();`
`@@ -153,27 +158,28 @@ class ModalPassData {`
`153`	`158`	`}`
`154`	`159`
`155`	`160`	`submit() {`
	`161`	`+ console.time('modal');`
`156`	`162`	`this.viewCtrl.dismiss(this.data);`
`157`	`163`	`}`
`158`	`164`
`159`	`165`	`ionViewLoaded(){`
`160`		`- console.log("ModalPassData ionViewLoaded fired");`
	`166`	`+ console.log('ModalPassData ionViewLoaded fired');`
`161`	`167`	`}`
`162`	`168`
`163`	`169`	`ionViewWillEnter(){`
`164`		`- console.log("ModalPassData ionViewWillEnter fired");`
	`170`	`+ console.log('ModalPassData ionViewWillEnter fired');`
`165`	`171`	`}`
`166`	`172`
`167`	`173`	`ionViewDidEnter(){`
`168`		`- console.log("ModalPassData ionViewDidEnter fired");`
	`174`	`+ console.log('ModalPassData ionViewDidEnter fired');`
`169`	`175`	`}`
`170`	`176`
`171`	`177`	`ionViewWillLeave(){`
`172`		`- console.log("ModalPassData ionViewWillLeave fired");`
	`178`	`+ console.log('ModalPassData ionViewWillLeave fired');`
`173`	`179`	`}`
`174`	`180`
`175`	`181`	`ionViewDidLeave(){`
`176`		`- console.log("ModalPassData ionViewDidLeave fired");`
	`182`	`+ console.log('ModalPassData ionViewDidLeave fired');`
`177`	`183`	`}`
`178`	`184`	`}`
`179`	`185`
`@@ -365,15 +371,15 @@ class ModalFirstPage {`
`365`	`371`	`}`
`366`	`372`
`367`	`373`	`ionViewLoaded(){`
`368`		`- console.log("ModalFirstPage ionViewLoaded fired");`
	`374`	`+ console.log('ModalFirstPage ionViewLoaded fired');`
`369`	`375`	`}`
`370`	`376`
`371`	`377`	`ionViewWillEnter(){`
`372`		`- console.log("ModalFirstPage ionViewWillEnter fired");`
	`378`	`+ console.log('ModalFirstPage ionViewWillEnter fired');`
`373`	`379`	`}`
`374`	`380`
`375`	`381`	`ionViewDidEnter(){`
`376`		`- console.log("ModalFirstPage ionViewDidEnter fired");`
	`382`	`+ console.log('ModalFirstPage ionViewDidEnter fired');`
`377`	`383`	`}`
`378`	`384`
`379`	`385`	`openActionSheet() {`
`@@ -446,15 +452,15 @@ class ModalSecondPage {`
`446`	`452`	`}`
`447`	`453`
`448`	`454`	`ionViewLoaded(){`
`449`		`- console.log("ModalSecondPage ionViewLoaded");`
	`455`	`+ console.log('ModalSecondPage ionViewLoaded');`
`450`	`456`	`}`
`451`	`457`
`452`	`458`	`ionViewWillEnter(){`
`453`		`- console.log("ModalSecondPage ionViewWillEnter");`
	`459`	`+ console.log('ModalSecondPage ionViewWillEnter');`
`454`	`460`	`}`
`455`	`461`
`456`	`462`	`ionViewDidEnter(){`
`457`		`- console.log("ModalSecondPage ionViewDidEnter");`
	`463`	`+ console.log('ModalSecondPage ionViewDidEnter');`
`458`	`464`	`}`
`459`	`465`	`}`
`460`	`466`