A modal element that presents relevant information or actions.
The Dialog overtakes the user's entire viewport until it is dismissed, preventing mouse and keyboard interaction with other parts of the page while open. This is a significant interruption in the user experience, so this component should be used with care.
The parent component controls whether the Dialog is open via
A Dialog can offer two kinds of actions (represented by buttons of the appropriate type): primary action (can be progressive or destructive), and default action (typically a safe option like "cancel").
The Dialog component can either be used on its own (in which case it displays in-place, using CSS positioning and z-index to overlay the rest of the viewport), or it can be used along with Vue's built-in
<teleport> component to move the component elsewhere in the DOM. This latter approach may be useful when Dialog is embedded in a large/complex page with other absolutely-positioned elements near the end of the markup.
When open, the Dialog adds a class to the document body to prevent scrolling; this is applied whether or not teleport is used.
Attributes passed to inner element
This component forwards any attributes applied by the user to the inner
.cdx-dialog element, instead of applying them to the outermost backdrop element.
This example includes a title, close button label (which enables the appearance of the icon-only close button), primary action, and default action.
With expandable menus
Expandable menus, like the one used by the Select component, will extend past the end of the dialog frame (instead of being cut off by it).
With overflowing content
When content in the default slot (the dialog body) is longer than the available space, the body section will scroll while the dialog header and footer will remain in view.
With stacked actions
When action button text is long, use the
stackedActions prop to stack the action buttons vertically.
With optional Footer Text
footer-text slot can accept plain text, links, and basic formatting markup; do not use it to provide images or block-level elements. All content provided is wrapped inside of a
<p> tag. Use this slot for situations like showing a disclaimer, linking to help or legal documentation, etc. The
footer-text content will appear above the dialog actions.
With custom Header and Footer
By default, the Dialog displays a header with an optional title, subtitle, and close button, and a footer with optional buttons and footer text.
The entire content of the header and footer can be replaced with user-provided markup (by using the
#footer slots, respectively). This allows for the creation of one-off custom dialogs as well as variant Dialog components that wrap the base Dialog with some additional content and styling.
Reusable custom Dialog example
The example above demonstrates a unique Dialog instance, suitable for a one-off dialog. For a re-usable custom dialog, consider using a wrapper component.
A wrapper component could pre-apply certain customizations (a consistent custom header or footer, for example) while still accepting
<slot> content from the user that gets forwarded to the Dialog's own slots.
An example of how to write such a component can be found below. This example relies on Codex's
useModelWrapper composable to pass a
v-model binding from the parent context down to the inner Dialog component.
Usage of the custom component would look like this:
<wrapped-dialog title="Custom dialog header" v-model:open="wrappedDialogState" > Custom dialog content. </wrapped-dialog>
|Whether the dialog is visible. Should be provided via a v-model:open binding in the parent scope.|
|Title for the dialog header. Used for ARIA purposes even if no visible header element is displayed.|
|Optional subtitle for the dialog.|
|Whether the dialog header should hide the title & subtitle|
|Label for the icon-only close button in the header.|
Including this prop adds the close button.
|Primary user action. This will display a primary button with the specified action (progressive or destructive).|
|Default user action. This will display a normal button.|
|Whether action buttons should be vertically stacked and 100% width.|
|When the primary action button is clicked.|
|When the default action button is clicked.|
|newValue ||When the open/close state changes, e.g. when the close button is clicked.|
|header||Customizable Dialog header|
|footer||Customizable Dialog footer|
|footer-text||Optional footer text|