javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-11-10 00:27:41 +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

10
core/src/components/action-sheet/action-sheet.tsx
View File

@ -128,6 +128,12 @@ export class ActionSheet implements ComponentInterface, OverlayInterface {
/**
* Dismiss the action sheet 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 action sheet.
* This can be useful in a button handler for determining which button was
* clicked to dismiss the action sheet.
* Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`.
*/
@Method()
dismiss(data?: any, role?: string): Promise<boolean> {
@ -135,7 +141,7 @@ export class ActionSheet implements ComponentInterface, OverlayInterface {
}
/**
* Returns a promise that resolves when the action-sheet did dismiss.
* Returns a promise that resolves when the action sheet did dismiss.
*/
@Method()
onDidDismiss(): Promise<OverlayEventDetail> {
@ -143,7 +149,7 @@ export class ActionSheet implements ComponentInterface, OverlayInterface {
}
/**
* Returns a promise that resolves when the action-sheet will dismiss.
* Returns a promise that resolves when the action sheet will dismiss.
*
*/
@Method()

12
core/src/components/action-sheet/readme.md
View File

@ -289,10 +289,10 @@ Dismiss the action sheet overlay after it has been presented.
#### Parameters
| Name | Type | Description |
| ------ | --------------------- | ----------- |
| `data` | `any` | |
| `role` | `string \| undefined` | |
| Name | Type | Description |
| ------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `data` | `any` | Any data to emit in the dismiss events. |
| `role` | `string \| undefined` | The role of the element that is dismissing the action sheet. This can be useful in a button handler for determining which button was clicked to dismiss the action sheet. Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. |
#### Returns
@ -302,7 +302,7 @@ Type: `Promise<boolean>`
### `onDidDismiss() => Promise<OverlayEventDetail<any>>`
Returns a promise that resolves when the action-sheet did dismiss.
Returns a promise that resolves when the action sheet did dismiss.
#### Returns
@ -312,7 +312,7 @@ Type: `Promise<OverlayEventDetail<any>>`
### `onWillDismiss() => Promise<OverlayEventDetail<any>>`
Returns a promise that resolves when the action-sheet will dismiss.
Returns a promise that resolves when the action sheet will dismiss.
#### Returns

1
core/src/components/action-sheet/test/test.utils.ts
View File

@ -50,7 +50,6 @@ export async function testActionSheetBackdrop(
actionSheet: any
) {
try {
console.log('backdrop hook');
const backdrop = await page.find('ion-backdrop');
await backdrop.click();