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
Node

Buttons, typically to close or take action in the dialog.

casing
String

Configures the mode of uppercasing of the title that should be performed.

Default: 'upper'
children
Node

The contents to be displayed in the body of the Dialog.

noAnimation
Boolean

When true, the dialog will not animate on/off screen.

Default: false
noDivider
Boolean

When true, a divider line will not separate the title from the dialog body

Default: false
onClose
Function

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 the open property to false.

onHide
Function

A function to be run after transition for hiding is finished.

open
Boolean

When true, the control is in the expanded state with the contents visible

Default: false
preserveCase
Boolean

When true, the case of title will be preserved

replaced by casing

Default: false
scrimType
String

Types of scrim. It can be either 'transparent', 'translucent', or 'none'.

Default: 'translucent'
showCloseButton
Boolean

When true, the close button is shown; when false, it is hidden.

Default: false
showDivider
Boolean

When true, a divider line separates the title from the dialog body

This is deprecated.

title
String

Title of the header

titleBelow
String

Text displayed below the title

ArrayBooleanFunctionModuleNumberObjectString