A component that displays a popover next to an element. The popover can be used to display extra information about a component or a tooltip. Another common way to use the popover is to display a menu when a button on the screen is tapped.
<Page>
<Button
ref={(btn) => { this.btn = btn; }}
onClick={() =>
this.setState({target: this.btn, isOpen: true})
}
/>
<Popover
isOpen={this.state.isOpen}
onCancel={() => this.setState({isOpen: false})}
getTarget={() => this.state.target}
>
<div style={{textAlign: 'center', opacity: 0.5}}>
<p>This is a popover!</p>
<p><small>Click the background to remove the popover.</small></p>
</div>
</Popover>
</Page>
Name | Type | Description |
---|---|---|
getTarget | func | This function should return a ref to the DOM node that the popover will target. Required. |
onDialogCancel | func | Called only if isCancelable is true. It will be called after tapping the background or by pressing the back button on Android devices. Optional. |
onCancel | func |
DEPRECATED! Use onDialogCancel instead.
Optional.
|
isOpen | bool | Indicates whether the dialog is open and shown. Required. |
cancelable | bool |
Specifies whether the dialog is cancelable or not. A cancelable dialog will call onCancel when tapping the background or or pressing the back button on Android devices Optional. |
isCancelable | bool |
DEPRECATED! Use cancelable instead.
Optional.
|
disabled | bool | Specifies whether the dialog is disabled. Optional. |
isDisabled | bool |
DEPRECATED! Use disabled instead.
Optional.
|
animation | string |
The animation used when showing and hiding the dialog. Can be either "none" or "default" .
Optional.
|
modifier | string | The appearance of the dialog. Optional. |
maskColor | string | Color of the background mask. Default is “rgba(0, 0, 0, 0.2)” Optional. |
animationOptions | object |
Specify the animation’s duration, delay and timing. E.g. {duration: 0.2, delay: 0.4, timing: 'ease-in'} .
Optional.
|
onPreShow | func | Called just before the alert dialog is displayed. Optional. |
onPostShow | func | Called just after the alert dialog is displayed. Optional. |
onPreHide | func | Called just before the alert dialog is hidden. Optional. |
onPostHide | func | Called just after the alert dialog is hidden. Optional. |
onDeviceBackButton | func | Custom handler for device back button. Optional. |
If you have any questions, use our Community Forum or talk to us on Discord chat. The Onsen UI team and your peers in the community will work together to help solve your issues.
For bug reports and feature requests use our GitHub Issues page.