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

docs(all): possible values are extracted by stencil (#16190)

Browse Source 
* docs(all): possible values are extracted by stencil

* add defaults

* remove all hardcoded defaults

* update stencil
This commit is contained in:
Manu MA
2018-11-02 00:06:40 +01:00
committed by GitHub
parent 335acf96ee
commit ecc2c55370
151 changed files with 1363 additions and 1430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
core/src/components/picker/picker.tsx
View File

@ -30,7 +30,6 @@ export class Picker implements ComponentInterface, OverlayInterface {
/**
* The mode determines which platform styles to use.
* Possible values are: `"ios"` or `"md"`.
*/
@Prop() mode!: Mode;
@ -71,17 +70,17 @@ export class Picker implements ComponentInterface, OverlayInterface {
@Prop() duration = 0;
/**
* If `true`, a backdrop will be displayed behind the picker. Defaults to `true`.
* If `true`, a backdrop will be displayed behind the picker.
*/
@Prop() showBackdrop = true;
/**
* If `true`, the picker will be dismissed when the backdrop is clicked. Defaults to `true`.
* If `true`, the picker will be dismissed when the backdrop is clicked.
*/
@Prop() backdropDismiss = true;
/**
* If `true`, the picker will animate. Defaults to `true`.
* If `true`, the picker will animate.
*/
@Prop() animated = true;

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

@ -9,32 +9,32 @@ A Picker is a dialog that displays a row of buttons and columns underneath. It a
## Properties
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `animated` | `animated` | If `true`, the picker will animate. Defaults to `true`. | `boolean` |
| `backdropDismiss` | `backdrop-dismiss` | If `true`, the picker will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` |
| `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[] \| undefined` |
| `duration` | `duration` | Number of milliseconds to wait before dismissing the picker. | `number` |
| `enterAnimation` | -- | Animation to use when the picker is presented. | `AnimationBuilder \| undefined` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `leaveAnimation` | -- | Animation to use when the picker is dismissed. | `AnimationBuilder \| undefined` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `"ios" \| "md"` |
| `overlayIndex` | `overlay-index` | | `number` |
| `showBackdrop` | `show-backdrop` | If `true`, a backdrop will be displayed behind the picker. Defaults to `true`. | `boolean` |
| Property | Attribute | Description | Type | Default |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------- | --------------------------------- | ----------- |
| `animated` | `animated` | If `true`, the picker will animate. | `boolean` | `true` |
| `backdropDismiss` | `backdrop-dismiss` | If `true`, the picker will be dismissed when the backdrop is clicked. | `boolean` | `true` |
| `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[] \| undefined` | `undefined` |
| `duration` | `duration` | Number of milliseconds to wait before dismissing the picker. | `number` | `0` |
| `enterAnimation` | -- | Animation to use when the picker is presented. | `AnimationBuilder \| undefined` | `undefined` |
| `keyboardClose` | `keyboard-close` | If `true`, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` | `true` |
| `leaveAnimation` | -- | Animation to use when the picker is dismissed. | `AnimationBuilder \| undefined` | `undefined` |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `overlayIndex` | `overlay-index` | | `number` | `undefined` |
| `showBackdrop` | `show-backdrop` | If `true`, a backdrop will be displayed behind the picker. | `boolean` | `true` |
## Events
| Event | Detail | Description |
| ---------------------- | ------------------ | ---------------------------------------- |
| `ionPickerDidDismiss` | OverlayEventDetail | 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` | OverlayEventDetail | Emitted before the picker has dismissed. |
| `ionPickerWillPresent` | | Emitted before the picker has presented. |
| Event | Description | Detail |
| ---------------------- | ---------------------------------------- | ------------------ |
| `ionPickerDidDismiss` | Emitted after the picker has dismissed. | OverlayEventDetail |
| `ionPickerDidLoad` | Emitted after the picker has loaded. | void |
| `ionPickerDidPresent` | Emitted after the picker has presented. | void |
| `ionPickerDidUnload` | Emitted after the picker has unloaded. | void |
| `ionPickerWillDismiss` | Emitted before the picker has dismissed. | OverlayEventDetail |
| `ionPickerWillPresent` | Emitted before the picker has presented. | void |
## Methods