Dialog
- Usage
- Styling
Dialog is a small window that can be used to present information and user interface elements in an overlay.
new tab
<Dialog
headerTitle="New employee"
opened={dialogOpened}
onOpenedChanged={({ detail }) => {
setDialogOpened(detail.value);
}}
footerRenderer={() => (
<>
<Button onClick={() => setDialogOpened(false)}>Cancel</Button>
<Button theme="primary" onClick={() => setDialogOpened(false)}>
Add
</Button>
</>
)}
>
<VerticalLayout style={{ alignItems: 'stretch', width: '18rem', maxWidth: '100%' }}>
<TextField label="First name" />
<TextField label="Last name" />
</VerticalLayout>
</Dialog>
<Button onClick={() => setDialogOpened(true)}>Show dialog</Button>Structure
The Dialog component has static header and footer areas, and a scrolling content area between them. The header and footer are optional, and automatically hidden if empty and not explicitly enabled.
Header
The header contains an optional title element, and a slot next to it for custom header content, such as a close button.
new tab
<Dialog
header-title="User details"
opened={dialogOpened}
onOpenedChanged={(event) => {
setDialogOpened(event.detail.value);
}}
headerRenderer={() => (
<Button theme="tertiary" onClick={close}>
<Icon icon="lumo:cross" />
</Button>
)}
>
<VerticalLayout
theme="spacing"
style={{ width: '300px', maxWidth: '100%', alignItems: 'stretch' }}
>
<VerticalLayout style={{ alignItems: 'stretch' }}>
<TextField
label="Name"
value={`${user?.firstName} ${user?.lastName}`}
readonly
style={{ paddingTop: 0 }}
/>
<EmailField label="Email" value={user?.email} readonly />
<TextField label="Address" value={addressDescription()} readonly />
</VerticalLayout>
</VerticalLayout>
</Dialog>
<Button onClick={open}>Show dialog</Button>Footer
Buttons for closure actions, such as Save, Cancel, Delete, and so on, should be placed in the footer. See the Button component for guidelines for the placement of buttons in dialogs. Footer content is right-aligned by default. Components can be left-aligned by applying a margin:
new tab
<Dialog
headerTitle={`Delete user "${user?.firstName} ${user?.lastName}"?`}
opened={dialogOpened}
onOpenedChanged={(event) => {
setDialogOpened(event.detail.value);
}}
footerRenderer={() => (
<>
<Button theme="primary error" onClick={close} style={{ marginRight: 'auto' }}>
Delete
</Button>
<Button theme="tertiary" onClick={close}>
Cancel
</Button>
</>
)}
>
Are you sure you want to delete this user permanently?
</Dialog>Padding
The content area’s built-in padding can be removed by applying the no-padding theme variant.
new tab
<Dialog
theme="no-padding"
header-title="Filter reports by users:"
opened={dialogOpened}
onOpenedChanged={({ detail }) => setDialogOpened(detail.value)}
footerRenderer={() => (
<Button theme="primary" onClick={() => setDialogOpened(false)}>
Filter
</Button>
)}
>
<Grid items={people} style={{ width: '500px', maxWidth: '100%' }}>
<GridSelectionColumn />
<GridColumn header="Name">
{({ item }) => (
<>
{item.firstName} {item.lastName}
</>
)}
</GridColumn>
</Grid>
</Dialog>Modality
A modal dialog blocks the user from interacting with the rest of the user interface while the dialog is open. A non-modal dialog, however, doesn’t block interaction.
Dialogs are modal by default.
Use modal dialogs for:
-
displaying important information, like system errors
-
requesting user input as part of a workflow, for example an edit dialog
-
confirmation of irreversible actions, such as deleting data (Confirm Dialog is a convenient alternative for these use cases)
-
breaking out sub-tasks into a separate user interface
Use non-modal dialogs:
-
when the user needs access to the content below the dialog
-
for less critical, optional, and/or support tasks
<Dialog modeless>...</Dialog>Usually, non-modal dialogs should be draggable, so that the user can move them to access the user interface beneath.
Draggable
Dialogs can be made draggable, enabling the user to move them around using a pointing device.
By default, the outer edges of a dialog, as well as the space between its components, can be used to move the dialog around.
The default areas from which a dialog can be dragged depend on whether the built-in header is used:
-
If the built-in header or footer is used, they function as the default drag handles of the dialog
-
Without the built-in header, any empty space within the dialog functions as a drag handle
Any component contained within a dialog can be marked and used as a drag handle by applying the draggable class name to it.
You can choose whether to make the component’s content draggable as well, or only the component itself.
new tab
<Dialog
aria-label="Add note"
draggable
modeless
opened={dialogOpened}
onOpenedChanged={(event) => {
setDialogOpened(event.detail.value);
}}
headerRenderer={() => (
<h2
className="draggable"
style={{
flex: 1,
cursor: 'move',
margin: 0,
fontSize: '1.5em',
fontWeight: 'bold',
padding: 'var(--lumo-space-m) 0',
}}
>
Add note
</h2>
)}
footerRenderer={() => (
<>
<Button onClick={close}>Cancel</Button>
<Button theme="primary" onClick={close}>
Add note
</Button>
</>
)}
>
<VerticalLayout
theme="spacing"
style={{ width: '300px', maxWidth: '100%', alignItems: 'stretch' }}
>
<VerticalLayout style={{ alignItems: 'stretch' }}>
<TextField label="Title" />
<TextArea label="Description" />
</VerticalLayout>
</VerticalLayout>
</Dialog>It’s recommended to make non-modal dialogs draggable, so that the user can interact with content that might otherwise be obscured by the Dialog. For example, a Dialog for taking notes or for adding widgets to a dashboard by dragging can offer a better experience by allowing the user to move the Dialog around.
Modal dialogs don’t benefit from being draggable, as their modality curtain (the dark overlay behind the dialog) obscures the underlying user interface.
Resizable
A resizable dialog allows the user to resize the Dialog by dragging from the edges of the Dialog with a pointing device. Dialogs aren’t resizable by default.
Dialogs containing dynamic content and/or a lot of information, such as complex forms or Grids, may benefit from being resizable, as this offers the user some flexibility with how much data is visible at once. It also gives the user control over which part of the underlying user interface is obscured.
Dialogs that contain very little, or compact, information don’t need to be resizable.
new tab
<Dialog
headerTitle="Employee list"
resizable
draggable
opened={dialogOpened}
onOpenedChanged={(event) => {
setDialogOpened(event.detail.value);
}}
>
<VerticalLayout
theme="spacing"
style={{ maxWidth: '100%', minWidth: '300px', height: '100%', alignItems: 'stretch' }}
>
<Grid items={people}>
<GridColumn path="firstName" title="First name" />
<GridColumn path="lastName" title="Last name" />
<GridColumn path="email" title="Email" />
<GridColumn path="profession" title="Profession" />
<GridColumn path="membership" title="Membership" />
</Grid>
</VerticalLayout>
</Dialog>Closing
Modal dialogs are closable in three ways:
-
Pressing the Esc key
-
Clicking outside the Dialog
-
Programmatically, for example through the click of a Button
Providing an explicit button for closing a Dialog is recommended.
new tab
<Dialog
aria-label="System maintenance notice"
opened={dialogOpened}
onOpenedChanged={(event) => {
setDialogOpened(event.detail.value);
}}
>
<VerticalLayout
theme="spacing"
style={{ width: '300px', maxWidth: '100%', alignItems: 'stretch' }}
>
<h2 style={{ margin: 'var(--lumo-space-m) 0', fontSize: '1.5em', fontWeight: 'bold' }}>
System maintenance
</h2>
<p>
System maintenance will begin at 3 PM. It is schedule to conclude at 5PM. We apologise
for any inconvenience.
</p>
<Button onClick={close} style={{ alignSelf: 'flex-end' }}>
Close
</Button>
</VerticalLayout>
</Dialog>Best Practices
Use Sparingly
Dialogs are disruptive by nature and should be used sparingly. Don’t use them to communicate non-essential information, such as success messages like “Logged in”, “Copied”, and so on. Instead, use Notifications when appropriate.
Button Placement
See Buttons in Dialogs.