docs(overlay): onDidDismiss() and onWillDismiss()

This commit is contained in:
Manu Mtz.-Almeida
2018-09-07 16:44:57 +02:00
parent 2f2a255436
commit bf486e2c99
15 changed files with 75 additions and 92 deletions

View File

@@ -137,7 +137,7 @@ export class Loading implements OverlayInterface {
@Listen('ionBackdropTap')
protected onBackdropTap() {
return this.dismiss(null, BACKDROP);
return this.dismiss(undefined, BACKDROP);
}
/**
@@ -167,8 +167,7 @@ export class Loading implements OverlayInterface {
}
/**
* Returns a promise that resolves when the loading did dismiss. It also accepts a callback
* that is called in the same circumstances.
* Returns a promise that resolves when the loading did dismiss.
*/
@Method()
onDidDismiss(): Promise<OverlayEventDetail> {
@@ -176,8 +175,7 @@ export class Loading implements OverlayInterface {
}
/**
* Returns a promise that resolves when the loading will dismiss. It also accepts a callback
* that is called in the same circumstances.
* Returns a promise that resolves when the loading will dismiss.
*/
@Method()
onWillDismiss(): Promise<OverlayEventDetail> {

View File

@@ -49,12 +49,12 @@ The loading indicator can be dismissed automatically after a specific amount of
## Methods
| Method | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `dismiss` | Dismiss the loading overlay after it has been presented. |
| `onDidDismiss` | Returns a promise that resolves when the loading did dismiss. It also accepts a callback that is called in the same circumstances. |
| `onWillDismiss` | Returns a promise that resolves when the loading will dismiss. It also accepts a callback that is called in the same circumstances. |
| `present` | Present the loading overlay after it has been created. |
| Method | Description |
| --------------- | -------------------------------------------------------------- |
| `dismiss` | Dismiss the loading overlay after it has been presented. |
| `onDidDismiss` | Returns a promise that resolves when the loading did dismiss. |
| `onWillDismiss` | Returns a promise that resolves when the loading will dismiss. |
| `present` | Present the loading overlay after it has been created. |
----------------------------------------------