ecc2c55370
* docs(all): possible values are extracted by stencil * add defaults * remove all hardcoded defaults * update stencil
5.9 KiB
ion-popover
A Popover is a dialog that appears on top of the current page. It can be used for anything, but generally it is used for overflow actions that don't fit in the navigation bar.
Creating
Popovers can be created using a Popover Controller. They can be customized by passing popover options in the popover controller's create method.
Presenting
To present a popover, call the present method on a popover instance. In order to position the popover relative to the element clicked, a click event needs to be passed into the options of the the present method. If the event is not passed, the popover will be positioned in the center of the viewport.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
animated |
animated |
If true, the popover will animate. |
boolean |
true |
backdropDismiss |
backdrop-dismiss |
If true, the popover will be dismissed when the backdrop is clicked. |
boolean |
true |
componentProps |
-- | The data to pass to the popover component. | undefined | { [key: string]: any; } |
undefined |
component |
component |
The component to display inside of the popover. | Function | HTMLElement | null | string |
undefined |
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 |
delegate |
-- | FrameworkDelegate | undefined |
undefined |
|
enterAnimation |
-- | Animation to use when the popover is presented. | AnimationBuilder | undefined |
undefined |
event |
-- | The event to pass to the popover animation. | any |
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 popover 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 popover. |
boolean |
true |
translucent |
translucent |
If true, the popover will be translucent. |
boolean |
false |
Events
| Event | Description | Detail |
|---|---|---|
ionPopoverDidDismiss |
Emitted after the popover has dismissed. | OverlayEventDetail |
ionPopoverDidLoad |
Emitted after the popover has loaded. | void |
ionPopoverDidPresent |
Emitted after the popover has presented. | void |
ionPopoverDidUnload |
Emitted after the popover has unloaded. | void |
ionPopoverWillDismiss |
Emitted before the popover has dismissed. | OverlayEventDetail |
ionPopoverWillPresent |
Emitted before the popover has presented. | void |
Methods
dismiss(data?: any, role?: string | undefined) => Promise<boolean>
Dismiss the popover overlay after it has been presented.
Parameters
| Name | Type | Description |
|---|---|---|
data |
any |
|
role |
string | undefined |
Returns
Type: Promise<boolean>
onDidDismiss() => Promise<OverlayEventDetail<any>>
Returns a promise that resolves when the popover did dismiss.
Returns
Type: Promise<OverlayEventDetail<any>>
onWillDismiss() => Promise<OverlayEventDetail<any>>
Returns a promise that resolves when the popover will dismiss.
Returns
Type: Promise<OverlayEventDetail<any>>
present() => Promise<void>
Present the popover overlay after it has been created.
Returns
Type: Promise<void>
Built with StencilJS