<Dialog />

Dialog that is displayed on top of current screen. As opposed to the AlertDialog element, this component can contain any kind of content. The dialog is useful for displaying menus, additional information or to ask the user to make a decision. It will automatically be displayed as Material Design when running on an Android device.

Tutorial

Dialogs

There are three components used to show dialogs: Dialog, AlertDialog and Toast. The Dialog component is a general dialog where you can put any content. AlertDialog has some default styles that make it easy to show errors, warnings or questions to the user. And Toast is a message (with optional button) that does not stop the app flow.

To show or hide the dialog the isOpen prop is used.

<Dialog isOpen={this.state.dialogShown}>
  Hi!

  <Button onClick={this.hideDialog.bind(this)}>
    Close
  </Button>
</Dialog>

Notification methods

The ons.notification object contains some useful methods to easily show alerts, confirmation dialogs and prompts:

  • ons.notification.alert(message, options)
  • ons.notificaiton.confirm(message, options)
  • ons.notification.prompt(message, options)
  • ons.notification.toast(message, options)

They all return a Promise object that can be used to handle the input from the user.

ons.notification.confirm('Are you ready?')
  .then((response) => {
    // Handle response.
  });

Props

Name Type Default Value Description
onCancel function Called only if isCancelable is true. It will be called after tapping the background or by pressing the back button on Android devices. Optional.
isOpen bool Indicates whether the dialog is open and shown. Required.
isCancelable 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.
isDisabled bool Specifies whether the dialog is disabled. 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 function Called just before the alert dialog is displayed. Optional.
onPostShow function Called just after the alert dialog is displayed. Optional.
onPreHide function Called just before the alert dialog is hidden. Optional.
onPostHide function Called just after the alert dialog is hidden. Optional.
onDeviceBackButton function Custom handler for device back button. Optional.

Preset Modifiers

Name Description
material Display a Material Design dialog.

Discussion

Need Help?

If you have any questions, use our Community Forum or talk to us via Gitter 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.