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

220
core/src/components/modal/readme.md
View File

@@ -14,207 +14,41 @@ Modals can be created using a [Modal Controller](../../modal-controller/ModalCon
## Properties
#### component
string
The component to display inside of the modal.
#### componentProps
ComponentProps
The data to pass to the modal component.
#### cssClass
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### delegate
FrameworkDelegate
#### enableBackdropDismiss
boolean
If true, the modal will be dismissed when the backdrop is clicked. Defaults to `true`.
#### enterAnimation
AnimationBuilder
Animation to use when the modal is presented.
#### keyboardClose
boolean
#### leaveAnimation
AnimationBuilder
Animation to use when the modal is dismissed.
#### overlayId
number
#### showBackdrop
boolean
If true, a backdrop will be displayed behind the modal. Defaults to `true`.
#### willAnimate
boolean
If true, the modal will animate. Defaults to `true`.
## Attributes
#### component
string
The component to display inside of the modal.
#### component-props
The data to pass to the modal component.
#### css-class
string
Additional classes to apply for custom CSS. If multiple classes are
provided they should be separated by spaces.
#### delegate
#### enable-backdrop-dismiss
boolean
If true, the modal will be dismissed when the backdrop is clicked. Defaults to `true`.
#### enter-animation
Animation to use when the modal is presented.
#### keyboard-close
boolean
#### leave-animation
Animation to use when the modal is dismissed.
#### overlay-id
number
#### show-backdrop
boolean
If true, a backdrop will be displayed behind the modal. Defaults to `true`.
#### will-animate
boolean
If true, the modal will animate. Defaults to `true`.
| Property | Attribute | Description | Type |
| ----------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------- |
| `componentProps` | -- | The data to pass to the modal component. | `ComponentProps` |
| `component` | `component` | The component to display inside of the modal. | `ComponentRef` |
| `cssClass` | `css-class` | Additional classes to apply for custom CSS. If multiple classes are provided they should be separated by spaces. | `string | string[]` |
| `delegate` | -- | | `FrameworkDelegate` |
| `enableBackdropDismiss` | `enable-backdrop-dismiss` | If true, the modal will be dismissed when the backdrop is clicked. Defaults to `true`. | `boolean` |
| `enterAnimation` | -- | Animation to use when the modal is presented. | `AnimationBuilder` |
| `keyboardClose` | `keyboard-close` | | `boolean` |
| `leaveAnimation` | -- | Animation to use when the modal is dismissed. | `AnimationBuilder` |
| `overlayId` | `overlay-id` | | `number` |
| `showBackdrop` | `show-backdrop` | If true, a backdrop will be displayed behind the modal. Defaults to `true`. | `boolean` |
| `willAnimate` | `will-animate` | If true, the modal will animate. Defaults to `true`. | `boolean` |
## Events
#### ionModalDidDismiss
Emitted after the modal has dismissed.
#### ionModalDidLoad
Emitted after the modal has loaded.
#### ionModalDidPresent
Emitted after the modal has presented.
#### ionModalDidUnload
Emitted after the modal has unloaded.
#### ionModalWillDismiss
Emitted before the modal has dismissed.
#### ionModalWillPresent
Emitted before the modal has presented.
| Event | Description |
| --------------------- | --------------------------------------- |
| `ionModalDidDismiss` | Emitted after the modal has dismissed. |
| `ionModalDidLoad` | Emitted after the modal has loaded. |
| `ionModalDidPresent` | Emitted after the modal has presented. |
| `ionModalDidUnload` | Emitted after the modal has unloaded. |
| `ionModalWillDismiss` | Emitted before the modal has dismissed. |
| `ionModalWillPresent` | Emitted before the modal has presented. |
## Methods
#### dismiss()
Dismiss the modal overlay after it has been presented.
#### onDidDismiss()
Returns a promise that resolves when the modal did dismiss. It also accepts a callback
that is called in the same circustances.
#### onWillDismiss()
Returns a promise that resolves when the modal will dismiss. It also accepts a callback
that is called in the same circustances.
#### present()
Present the modal overlay after it has been created.
| Method | Description |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `dismiss` | Dismiss the modal overlay after it has been presented. |
| `onDidDismiss` | Returns a promise that resolves when the modal did dismiss. It also accepts a callback that is called in the same circustances. |
| `onWillDismiss` | Returns a promise that resolves when the modal will dismiss. It also accepts a callback that is called in the same circustances. |
| `present` | Present the modal overlay after it has been created. |
----------------------------------------------