javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +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

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

@@ -18,245 +18,43 @@ The loading indicator can be dismissed automatically after a specific amount of
## Properties
#### content
string
Optional text content to display in the loading indicator.
#### cssClass
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### dismissOnPageChange
boolean
If true, the loading indicator will dismiss when the page changes. Defaults to `false`.
#### duration
number
Number of milliseconds to wait before dismissing the loading indicator.
#### enableBackdropDismiss
boolean
If true, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
#### enterAnimation
AnimationBuilder
Animation to use when the loading indicator is presented.
#### keyboardClose
boolean
If true, the loading will blur any inputs and hide the keyboard
#### leaveAnimation
AnimationBuilder
Animation to use when the loading indicator is dismissed.
#### overlayId
number
#### showBackdrop
boolean
If true, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
#### spinner
string
The name of the spinner to display. Possible values are: `"lines"`, `"lines-small"`, `"dots"`,
`"bubbles"`, `"circles"`, `"crescent"`.
#### translucent
boolean
If true, the loading indicator will be translucent. Defaults to `false`.
#### willAnimate
boolean
If true, the loading indicator will animate. Defaults to `true`.
## Attributes
#### content
string
Optional text content to display in the loading indicator.
#### css-class
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### dismiss-on-page-change
boolean
If true, the loading indicator will dismiss when the page changes. Defaults to `false`.
#### duration
number
Number of milliseconds to wait before dismissing the loading indicator.
#### enable-backdrop-dismiss
boolean
If true, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`.
#### enter-animation
Animation to use when the loading indicator is presented.
#### keyboard-close
boolean
If true, the loading will blur any inputs and hide the keyboard
#### leave-animation
Animation to use when the loading indicator is dismissed.
#### overlay-id
number
#### show-backdrop
boolean
If true, a backdrop will be displayed behind the loading indicator. Defaults to `true`.
#### spinner
string
The name of the spinner to display. Possible values are: `"lines"`, `"lines-small"`, `"dots"`,
`"bubbles"`, `"circles"`, `"crescent"`.
#### translucent
boolean
If true, the loading indicator will be translucent. Defaults to `false`.
#### will-animate
boolean
If true, the loading indicator will animate. Defaults to `true`.
| Property | Attribute | Description | Type |
| ----------------------- | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `content` | `content` | Optional text content to display in the loading indicator. | `string` |
| `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string | string[]` |
| `dismissOnPageChange` | `dismiss-on-page-change` | If true, the loading indicator will dismiss when the page changes. Defaults to `false`. | `boolean` |
| `duration` | `duration` | Number of milliseconds to wait before dismissing the loading indicator. | `number` |
| `enableBackdropDismiss` | `enable-backdrop-dismiss` | If true, the loading indicator will be dismissed when the backdrop is clicked. Defaults to `false`. | `boolean` |
| `enterAnimation` | -- | Animation to use when the loading indicator is presented. | `AnimationBuilder` |
| `keyboardClose` | `keyboard-close` | If true, the loading will blur any inputs and hide the keyboard | `boolean` |
| `leaveAnimation` | -- | Animation to use when the loading indicator is dismissed. | `AnimationBuilder` |
| `overlayId` | `overlay-id` | | `number` |
| `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` |
| `willAnimate` | `will-animate` | If true, the loading indicator will animate. Defaults to `true`. | `boolean` |
## Events
#### ionLoadingDidDismiss
Emitted after the loading has dismissed.
#### ionLoadingDidLoad
Emitted after the loading has loaded.
#### ionLoadingDidPresent
Emitted after the loading has presented.
#### ionLoadingDidUnload
Emitted after the loading has unloaded.
#### ionLoadingWillDismiss
Emitted before the loading has dismissed.
#### ionLoadingWillPresent
Emitted before the loading has presented.
| Event | Description |
| ----------------------- | ----------------------------------------- |
| `ionLoadingDidDismiss` | Emitted after the loading has dismissed. |
| `ionLoadingDidLoad` | Emitted after the loading has loaded. |
| `ionLoadingDidPresent` | Emitted after the loading has presented. |
| `ionLoadingDidUnload` | Emitted after the loading has unloaded. |
| `ionLoadingWillDismiss` | Emitted before the loading has dismissed. |
| `ionLoadingWillPresent` | Emitted before the loading has presented. |
## Methods
#### dismiss()
Dismiss the loading overlay after it has been presented.
#### onDidDismiss()
Returns a promise that resolves when the loading did dismiss. It also accepts a callback
that is called in the same circumstances.
#### onWillDismiss()
Returns a promise that resolves when the loading will dismiss. It also accepts a callback
that is called in the same circumstances.
#### present()
Present the loading overlay after it has been created.
| Method | Description |
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `dismiss` | Dismiss the loading overlay after it has been presented. |
| `onDidDismiss` | Returns a promise that resolves when the loading did dismiss. It also accepts a callback that is called in the same circumstances. |
| `onWillDismiss` | Returns a promise that resolves when the loading will dismiss. It also accepts a callback that is called in the same circumstances. |
| `present` | Present the loading overlay after it has been created. |
----------------------------------------------