javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-22 13:32:54 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(): update to latest stencil

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-08-12 12:04:27 +02:00
parent 149039bd12
commit d856ecfbbf
101 changed files with 1098 additions and 8675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -9,220 +9,42 @@ A Picker is a dialog that displays a row of buttons and columns underneath. It a
## Properties
#### buttons
PickerButton[]
Array of buttons to be displayed at the top of the picker.
#### columns
PickerColumn[]
Array of columns to be displayed in the picker.
#### cssClass
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### duration
number
Number of milliseconds to wait before dismissing the picker.
#### enableBackdropDismiss
boolean
If true, the picker will be dismissed when the backdrop is clicked. Defaults to `true`.
#### enterAnimation
AnimationBuilder
Animation to use when the picker is presented.
#### keyboardClose
boolean
If the keyboard should be able to close the picker. Defaults to true.
#### leaveAnimation
AnimationBuilder
Animation to use when the picker is dismissed.
#### overlayId
number
#### showBackdrop
boolean
If true, a backdrop will be displayed behind the picker. Defaults to `true`.
#### willAnimate
boolean
If true, the picker will animate. Defaults to `true`.
## Attributes
#### buttons
Array of buttons to be displayed at the top of the picker.
#### columns
Array of columns to be displayed in the picker.
#### css-class
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### duration
number
Number of milliseconds to wait before dismissing the picker.
#### enable-backdrop-dismiss
boolean
If true, the picker will be dismissed when the backdrop is clicked. Defaults to `true`.
#### enter-animation
Animation to use when the picker is presented.
#### keyboard-close
boolean
If the keyboard should be able to close the picker. Defaults to true.
#### leave-animation
Animation to use when the picker is dismissed.
#### overlay-id
number
#### show-backdrop
boolean
If true, a backdrop will be displayed behind the picker. Defaults to `true`.
#### will-animate
boolean
If true, the picker will animate. Defaults to `true`.
| Property | Attribute | Description | Type |
| ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------- |
| `buttons` | -- | Array of buttons to be displayed at the top of the picker. | `PickerButton[]` |
| `columns` | -- | Array of columns to be displayed in the picker. | `PickerColumn[]` |
| `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string | string[]` |
| `duration` | `duration` | Number of milliseconds to wait before dismissing the picker. | `number` |
| `enableBackdropDismiss` | `enable-backdrop-dismiss` | If true, the picker will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` |
| `enterAnimation` | -- | Animation to use when the picker is presented. | `AnimationBuilder` |
| `keyboardClose` | `keyboard-close` | If the keyboard should be able to close the picker. Defaults to true. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the picker is dismissed. | `AnimationBuilder` |
| `overlayId` | `overlay-id` | | `number` |
| `showBackdrop` | `show-backdrop` | If true, a backdrop will be displayed behind the picker. Defaults to `true`. | `boolean` |
| `willAnimate` | `will-animate` | If true, the picker will animate. Defaults to `true`. | `boolean` |
## Events
#### ionPickerDidDismiss
Emitted after the picker has dismissed.
#### ionPickerDidLoad
Emitted after the picker has loaded.
#### ionPickerDidPresent
Emitted after the picker has presented.
#### ionPickerDidUnload
Emitted after the picker has unloaded.
#### ionPickerWillDismiss
Emitted before the picker has dismissed.
#### ionPickerWillPresent
Emitted before the picker has presented.
| Event | Description |
| ---------------------- | ---------------------------------------- |
| `ionPickerDidDismiss` | Emitted after the picker has dismissed. |
| `ionPickerDidLoad` | Emitted after the picker has loaded. |
| `ionPickerDidPresent` | Emitted after the picker has presented. |
| `ionPickerDidUnload` | Emitted after the picker has unloaded. |
| `ionPickerWillDismiss` | Emitted before the picker has dismissed. |
| `ionPickerWillPresent` | Emitted before the picker has presented. |
## Methods
#### dismiss()
Dismiss the picker overlay after it has been presented.
#### getColumn()
Returns the column the matches the specified name
#### onDidDismiss()
Returns a promise that resolves when the picker did dismiss. It also accepts a callback
that is called in the same circustances.
#### onWillDismiss()
Returns a promise that resolves when the picker will dismiss. It also accepts a callback
that is called in the same circustances.
#### present()
Present the picker overlay after it has been created.
| Method | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `dismiss` | Dismiss the picker overlay after it has been presented. |
| `getColumn` | Returns the column the matches the specified name |
| `onDidDismiss` | Returns a promise that resolves when the picker did dismiss. It also accepts a callback that is called in the same circustances. |
| `onWillDismiss` | Returns a promise that resolves when the picker will dismiss. It also accepts a callback that is called in the same circustances. |
| `present` | Present the picker overlay after it has been created. |
----------------------------------------------