Modal

The Modal component interrupts the user without leaving the current page. It forces the user to interact with critical information.

Developer Documentation

Information on how to implement this component is available for the following technologies.

Usage

A Modal should be used when there is critical information to show the user, a choice that the user must make immediately, a small amount of user information is needed, or when an action will result in a longer than normal wait.

The Modal component is inherently disruptive. It disables everything on the page below it until it is dismissed. The Modal component should be used sparingly, thoughtfully, and only when interruption is necessary to continuing a task.

Guidelines

  • Ensure that messaging is helpful and provides a clear path of action for the user.
  • The content inside of a Modal should be short and concise. If much more information is needed, consider sending the user to a new page.
  • A Modal should not be launched from within another Modal.

Variants

Choice

A Modal that asks a question and allows a user to take an action.

Developer Documentation

Information on how to implement this component is available for the following technologies.

Info

A Modal that shows critical information to the user.

Developer Documentation

Information on how to implement this component is available for the following technologies.

Wait

A Modal that acts as a loading screen. Once loading is finished, it will dismiss itself.

Developer Documentation

Information on how to implement this component is available for the following technologies.

Anatomy

  • A Modal (excluding the Wait Modal) must have a Button to trigger it.
  • A Modal (excluding the Wait Modal) must have a Close Icon to dismiss it.
  • A Modal has a background mask that covers up the page below.
  • A Modal must have a title.
  • A Modal must have informational text.
  • A Choice Modal must include a Button.

Accessibility

  • The Modal component can be fully controlled using a mouse, keyboard, and/or screen reader.
  • When a Modal is opened:
    • The first focusable element inside it will receive focus.
    • The focus is "trapped" inside the Modal. Pressing the Tab or Shift+Tab keys to move focus will only shift focus between the elements in the Modal.
  • Modals can be closed several ways:
    • Pressing the "Escape" key on the keyboard (excluding Wait Modal)
    • Pressing the Cancel button (in the Choice Modal).
    • Pressing the Close Icon (in the Choice Modal or Info Modal).
    • Pressing the background mask overlay (in the Choice Modal or Info Modal).
    • Wait Modal will close on its own.