javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-23 14:01:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(popover): clarify the dismiss of a popover (#7795)

Browse Source 
Clarify that that unfortunately-named onDidDismiss() is not a callback, but rather *sets up* a callback. Also explain dismiss()'s argument and its relation to said callback.
This commit is contained in:
softhorizons
2016-10-12 12:56:17 -07:00
committed by Brandy Carney
parent ca3b9455d1
commit dce4edf962
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/components/popover/popover.ts
View File

@ -81,10 +81,11 @@ export class Popover extends ViewController {
* To dismiss the popover after creation, call the `dismiss()` method on the * 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 * `Popover` instance. The popover can also be dismissed from within the popover's
* view by calling the `dismiss()` method on the [ViewController](../../nav/ViewController). * view by calling the `dismiss()` method on the [ViewController](../../nav/ViewController).
* The `onDidDismiss` function can be called to perform an action after the popover * The `dismiss()` call accepts an optional parameter that will be passed to the callback described
* is dismissed. The popover will dismiss when the backdrop is clicked, but this * as follows. The `onDidDismiss(<func>)` function can be called to set up a callback action that will
* can be disabled by setting `enableBackdropDismiss` to `false` in the popover * be performed after the popover is dismissed, receiving the parameter passed to `dismiss()`.
* options. * The popover will dismiss when the backdrop is clicked by implicitly performing `dismiss(null)`,
* but this can be disabled by setting `enableBackdropDismiss` to `false` in the popover options.
* *
* > Note that after the component is dismissed, it will not be usable anymore and * > Note that after the component is dismissed, it will not be usable anymore and
* another one must be created. This can be avoided by wrapping the creation and * another one must be created. This can be avoided by wrapping the creation and