javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-18 11:17:19 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(components): update method and parameter descriptions (#18075)

Browse Source
This commit is contained in:
Brandy Carney
2019-04-23 12:59:25 -04:00
committed by GitHub
parent bd96491d03
commit 464ec3b70a
56 changed files with 879 additions and 644 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
core/src/components/alert/alert.tsx
View File

@ -185,6 +185,12 @@ export class Alert implements ComponentInterface, OverlayInterface {
/**
* Dismiss the alert overlay after it has been presented.
*
* @param data Any data to emit in the dismiss events.
* @param role The role of the element that is dismissing the alert.
* This can be useful in a button handler for determining which button was
* clicked to dismiss the alert.
* Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`.
*/
@Method()
dismiss(data?: any, role?: string): Promise<boolean> {
@ -193,7 +199,6 @@ export class Alert implements ComponentInterface, OverlayInterface {
/**
* Returns a promise that resolves when the alert did dismiss.
*
*/
@Method()
onDidDismiss(): Promise<OverlayEventDetail> {
@ -202,7 +207,6 @@ export class Alert implements ComponentInterface, OverlayInterface {
/**
* Returns a promise that resolves when the alert will dismiss.
*
*/
@Method()
onWillDismiss(): Promise<OverlayEventDetail> {