docs(modal): include an example demonstrating onWillDismiss (ionic-team#14067)

spartanace1024 · brandyscarney · commit 9bcaff89f58f · 2018-03-12T12:27:17.000-04:00
* Include an example that shows off onWillDismiss

- onWillDismiss was never mentioned in documentation but can be very useful for displaying content before animation occurs. Updated to include an example of onWillDismiss.
- Added comments above both onDidDismiss and OnWillDismiss to further explain how they work.

* docs(modal): update indentation and add bracket
diff --git a/src/components/modal/modal-controller.ts b/src/components/modal/modal-controller.ts
@@ -77,37 +77,43 @@ import { DeepLinker } from '../../navigation/deep-linker';
  * @Component(...)
  * class HomePage {
  *
- *  constructor(public modalCtrl: ModalController) {
+ *   constructor(public modalCtrl: ModalController) {
  *
- *  }
- *
- *  presentContactModal() {
- *    let contactModal = this.modalCtrl.create(ContactUs);
- *    contactModal.present();
- *  }
+ *   }
  *
- *  presentProfileModal() {
- *    let profileModal = this.modalCtrl.create(Profile, { userId: 8675309 });
- *    profileModal.onDidDismiss(data => {
- *      console.log(data);
- *    });
- *    profileModal.present();
- *  }
+ *   presentContactModal() {
+ *     let contactModal = this.modalCtrl.create(ContactUs);
+ *     contactModal.present();
+ *   }
  *
+ *   presentProfileModal() {
+ *     let profileModal = this.modalCtrl.create(Profile, { userId: 8675309 });
+ *    
+ *     // fires after dismiss animation finishes
+ *     profileModal.onDidDismiss(data => {
+ *       console.log(data);
+ *     });
+ *    
+ *     // fires before dismiss animation begins
+ *     profileModal.onWillDismiss(data => {
+ *       console.log(data);
+ *     });
+ *
+ *     profileModal.present();
+ *   }
  * }
  *
  * @Component(...)
  * class Profile {
  *
- *  constructor(public viewCtrl: ViewController) {
- *
- *  }
+ *   constructor(public viewCtrl: ViewController) {
  *
- *  dismiss() {
- *    let data = { 'foo': 'bar' };
- *    this.viewCtrl.dismiss(data);
- *  }
+ *   }
  *
+ *   dismiss() {
+ *     let data = { 'foo': 'bar' };
+ *     this.viewCtrl.dismiss(data);
+ *   }
  * }
  * ```
  *
