moonstone/ Dialog
Exports the moonstone/Dialog.Dialog and moonstone/Dialog.DialogBase components. The default export is moonstone/Dialog.Dialog.
import Dialog from '@enact/moonstone/Dialog';
Members
DialogComponent
moonstone/Dialog.Dialog is modal component with a title, a subtitle, a message, and an area for additional controls.
import Dialog from '@enact/moonstone/Dialog';
DialogBaseComponent
moonstone/Dialog.DialogBase is a modal component with a title, a subtitle, a message, and an area for additional controls.
import {DialogBase} from '@enact/moonstone/Dialog';
Properties
- buttons
Buttons, typically to close or take action in the dialog.
- casing
Configures the mode of uppercasing of the
title
that should be performed.Default: 'upper'- children
The contents to be displayed in the body of the Dialog.
- noAnimation
When
true
, the dialog will not animate on/off screen.Default: false- noDivider
When
true
, a divider line will not separate the title from the dialog bodyDefault: false- onClose
A function to be run when a closing action is invoked by the user. These actions include pressing
ESC
key or clicking on the close button. It is the responsibility of the callback to set theopen
property tofalse
.- onHide
A function to be run after transition for hiding is finished.
- open
When
true
, the control is in the expanded state with the contents visibleDefault: false- preserveCase ✘
When
true
, the case oftitle
will be preservedreplaced by
casing
Default: false- scrimType
Types of scrim. It can be either
'transparent'
,'translucent'
, or'none'
.Default: 'translucent'- showCloseButton
When
true
, the close button is shown; whenfalse
, it is hidden.Default: false- showDivider ✘
When
true
, a divider line separates the title from the dialog bodyThis is deprecated.
- title
Title of the header
- titleBelow
Text displayed below the title