Skip to main content

An official website of the United States government

Here's how you know

Design System

An official website of the United States government

Here's how you know

Theme:

Design system switcher

Select a theme

Version:

Design system switcher

Select a version

What's new?

View code on GitHub

Theme:

Design system switcher

Select a theme

Version:

Design system switcher

Select a version

Modal Dialog

The dialog component can be used to focus a user's attention on a single piece of content, without taking them to a new screen. Please use with caution; view our guidance for more details.

Figma logoFigmaGithubStorybook logoStorybook

Examples

View interactive React examples in Storybook

Dialog size variants

Apply one of the size modifier classes to the ds-c-dialog element to change the dialog width.

  • .ds-c-dialog--narrow
  • .ds-c-dialog--wide
  • .ds-c-dialog--full

Code

React

See Storybook for React guidance of this component.

Style customization

The following CSS variables can be overridden to customize Dialog components:

CSS variables for dialog
VariableDefault Core Theme Value
--dialog__background-colorhex value: #ffffff--color-background
--dialog-overlay__background-colorhex value: #00000080--color-transparent-black-alpha50
--dialog__padding--spacer-4

Analytics

This component has analytics tracking available. Please see our developer documentation about using analytics in the design system.

Guidance

Accessibility

Keyboard support

  • Enter or Space to select the highlighted item.
  • Tab to move the focus sequentially through the list of focusable items.
  • Shift + Tab to move the focus sequentially through the list of focusable items in reversed order.

Focus Management

  • When the modal is opened, the entire modal is the default focus state. Most screen readers will announce the entire dialog content.
  • Focus is trapped within the modal and users can then navigate through the dialog actions with the keyboard.
  • Escape will close the modal. To disable exiting when users press the Escape key, set the escapeExits prop to false
  • When the modal closes, focus returns to the element that was focused just before the modal is activated
  • To place the focus inside of the dialog on activating the modal, set the dialog focus using the initialFocus prop with boolean prop focusDialog set to false

Learn more

Component maturity

For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.

Accessibility

  • Color

    Meets AA color contrast standards for accessibility and color blindness.
    Complete

  • Forced Colors Mode (FCM)

    While using FCM the components text is legible and improves readability.
    Complete

  • WCAG 2.1 Level AA Conformance

    All Axe checks for WCAG AA compliance have passed.
    Complete

  • Screen readers

    VoiceOver, NVDA, and JAWS screen readers provide concise communication and interaction.
    Complete

  • Keyboard navigation

    Component is fully navigable with a keyboard.
    Complete

Code

  • Storybook

    Component has stories to cover all defined props.
    Complete

  • Responsive

    Component designed to work in all responsive breakpoints.
    Complete

  • Spanish translations

    Includes Spanish translations for default text content.
    Complete

Tokens

  • Code

    Tokens implemented in code.
    Complete

  • Design

    Tokens implemented in the Sketch.
    Complete

On this page

Have ideas?