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

fix(all): docs for all missing props

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-10-11 16:02:15 -05:00
committed by Manu MA
parent 53305741a0
commit a72fced6fe
119 changed files with 1026 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -25,7 +25,7 @@ export class Picker implements ComponentInterface, OverlayInterface {
@Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement;
@Prop({ context: 'config' }) config!: Config;
/** @hidden */
/** @internal */
@Prop() overlayIndex!: number;
/**
@ -35,7 +35,7 @@ export class Picker implements ComponentInterface, OverlayInterface {
@Prop() mode!: Mode;
/**
* If true, the keyboard will be automatically dismissed when the overlay is presented.
* If `true`, the keyboard will be automatically dismissed when the overlay is presented.
*/
@Prop() keyboardClose = true;
@ -71,17 +71,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. Defaults to `true`.
*/
@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. Defaults to `true`.
*/
@Prop() backdropDismiss = true;
/**
* If true, the picker will animate. Defaults to `true`.
* If `true`, the picker will animate. Defaults to `true`.
*/
@Prop() animated = true;

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

@ -11,18 +11,18 @@ A Picker is a dialog that displays a row of buttons and columns underneath. It a
| 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` |
| `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[]` |
| `duration` | `duration` | Number of milliseconds to wait before dismissing the picker. | `number` |
| `enterAnimation` | -- | Animation to use when the picker is presented. | `AnimationBuilder` |
| `keyboardClose` | `keyboard-close` | If true, the keyboard will be automatically dismissed when the overlay is presented. | `boolean` |
| `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` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `overlayIndex` | `overlay-index` | | `number` |
| `showBackdrop` | `show-backdrop` | If true, a backdrop will be displayed behind the picker. Defaults to `true`. | `boolean` |
| `showBackdrop` | `show-backdrop` | If `true`, a backdrop will be displayed behind the picker. Defaults to `true`. | `boolean` |
## Events