javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 20:33:32 +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/picker/picker.tsx
View File

@ -129,6 +129,12 @@ export class Picker implements ComponentInterface, OverlayInterface {
/**
* Dismiss the picker 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 picker.
* This can be useful in a button handler for determining which button was
* clicked to dismiss the picker.
* Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`.
*/
@Method()
dismiss(data?: any, role?: string): Promise<boolean> {
@ -155,7 +161,9 @@ export class Picker implements ComponentInterface, OverlayInterface {
}
/**
* Returns the column the matches the specified name
* Get the column that matches the specified name.
*
* @param name The name of the column.
*/
@Method()
getColumn(name: string): Promise<PickerColumn | undefined> {

16
core/src/components/picker/readme.md
View File

@ -42,10 +42,10 @@ Dismiss the picker 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 picker. This can be useful in a button handler for determining which button was clicked to dismiss the picker. Some examples include: ``"cancel"`, `"destructive"`, "selected"`, and `"backdrop"`. |
#### Returns
@ -55,13 +55,13 @@ Type: `Promise<boolean>`
### `getColumn(name: string) => Promise<PickerColumn | undefined>`
Returns the column the matches the specified name
Get the column that matches the specified name.
#### Parameters
| Name | Type | Description |
| ------ | -------- | ----------- |
| `name` | `string` | |
| Name | Type | Description |
| ------ | -------- | ----------------------- |
| `name` | `string` | The name of the column. |
#### Returns