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

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 1025 additions and 656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core/src/components/loading/loading.tsx
View File

@ -26,6 +26,8 @@ export class Loading implements ComponentInterface, OverlayInterface {
@Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement;
@Prop({ context: 'config' }) config!: Config;
/** @internal */
@Prop() overlayIndex!: number;
/**
@ -35,7 +37,7 @@ export class Loading 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;
@ -66,12 +68,12 @@ export class Loading implements ComponentInterface, OverlayInterface {
@Prop() duration = 0;
/**
* If true, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
* If `true`, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
*/
@Prop() backdropDismiss = false;
/**
* If true, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
* If `true`, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
*/
@Prop() showBackdrop = true;
@ -82,12 +84,12 @@ export class Loading implements ComponentInterface, OverlayInterface {
@Prop({ mutable: true }) spinner?: string;
/**
* If true, the loading indicator will be translucent. Defaults to `false`.
* If `true`, the loading indicator will be translucent. Defaults to `false`.
*/
@Prop() translucent = false;
/**
* If true, the loading indicator will animate. Defaults to `true`.
* If `true`, the loading indicator will animate. Defaults to `true`.
*/
@Prop() animated = true;

10
core/src/components/loading/readme.md
View File

@ -20,19 +20,19 @@ The loading indicator can be dismissed automatically after a specific amount of
| Property | Attribute | Description | Type |
| ----------------- | ------------------ | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------- |
| `animated` | `animated` | If true, the loading indicator will animate. Defaults to `true`. | `boolean` |
| `backdropDismiss` | `backdrop-dismiss` | If true, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`. | `boolean` |
| `animated` | `animated` | If `true`, the loading indicator will animate. Defaults to `true`. | `boolean` |
| `backdropDismiss` | `backdrop-dismiss` | If `true`, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`. | `boolean` |
| `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 loading indicator. | `number` |
| `enterAnimation` | -- | Animation to use when the loading indicator 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 loading indicator is dismissed. | `AnimationBuilder` |
| `message` | `message` | Optional text content to display in the loading indicator. | `string` |
| `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 loading indicator. Defaults to `true`. | `boolean` |
| `showBackdrop` | `show-backdrop` | If `true`, a backdrop will be displayed behind the loading indicator. Defaults to `true`. | `boolean` |
| `spinner` | `spinner` | The name of the spinner to display. Possible values are: `"lines"`, `"lines-small"`, `"dots"`, `"bubbles"`, `"circles"`, `"crescent"`. | `string` |
| `translucent` | `translucent` | If true, the loading indicator will be translucent. Defaults to `false`. | `boolean` |
| `translucent` | `translucent` | If `true`, the loading indicator will be translucent. Defaults to `false`. | `boolean` |
## Events