Dialog v2

import {Dialog} from '@primer/react/drafts'

The dialog component is the Primer implementation of the ARIA design pattern Dialog. A dialog is a type of overlay that can be used for confirming actions, asking for disambiguation, and presenting small forms. They generally allow the user to focus on a quick task without having to navigate to a different page.

Dialogs appear in the page after a direct user interaction. Don't show dialogs on page load or as system alerts.

Dialogs appear centered in the page, with a visible backdrop that dims the rest of the window for focus.

All dialogs should have a title and a close button. Use the title prop to set the title. The close button is created automatically, but must be handled with an onClose prop.

Dialogs are modal. Dialogs can be dismissed by clicking on the close button, by interacting with another button in the overlay, or by clicking outside of the overlay.

(Coming soon) Make sure larger dialogs remain mobile-friendly. Even large dialogs need to be responsive. A dialog's width and height will be readjusted depending on the screen size and should never exceed the available space. Use responsive solutions to adjust the UI so they behave well on smaller screens.

(Coming soon) Simple and small dialogs can remain as-is on mobile. As more elements are added to it, mobile-specific style variations such as Bottom sheet and Full-screen should be considered.

State

The dialog component is completely stateless. The parent component must conditionally render a dialog based on the necessary criteria. The parent component can be notified by a gesture to close the dialog (e.g. by clicking the "X" button or by pressing the Escape key) by passing in the onClose prop.

Accessibility

The dialog component is fully accessible out-of-the-box. The dialog's title is used for aria-labelledby, and the dialog's description is used for aria-describedby. The aria-modal="true" attribute is used to inform screen readers that the rest of the content on the page is inert.

Keyboard

The default keyboard API for a dialog employs three mechanisms:

1. The Escape key can be pressed to close the dialog.
2. Focus is trapped within the top-most dialog. When a dialog is opened, the close button receives initial focus by default, or on a button defined with autoFocus: true.
3. If there are buttons in the dialog footer, focus can be moved between them with left and right arrow keys or tab/shift+tab.
4. When a dialog is closed, it can optionally handle returning focus to the element that was focused immediately before the dialog was opened. Otherwise, it is the consumer's responsibility to move focus to a suitable element.

Custom rendering

Note: using custom rendering allows breaking out of the defined design, UX, and accessibility patterns of the dialog. Use only as a last resort.

By default, the Dialog component implements the design and interactions defined by the Primer design system. If necessary, you can provide custom renderers for the header, body, or footer using the renderHeader, renderBody, and renderFooter props, respectively. The JSX produced by these render props will render full-bleed into their respective areas of the dialog. If you are using the custom renderers, you should use the provided sub-components Dialog.Header, Dialog.Title, Dialog.Subtitle, Dialog.CloseButton, Dialog.Body, Dialog.Footer, and Dialog.Buttons to the extent possible.

Example

<State default={false}>
  {([isOpen, setIsOpen]) => {
    const openDialog = React.useCallback(() => setIsOpen(true), [setIsOpen])
    const closeDialog = React.useCallback(() => setIsOpen(false), [setIsOpen])
    return (
      <>
        <Button onClick={openDialog}>Open</Button>
        {isOpen && (
          <Dialog
            title="Dialog example"
            subtitle={
              <>
                This is a <b>description</b> of the dialog.
              </>
            }
            footerButtons={[{content: 'Ok', onClick: closeDialog}]}
            onClose={closeDialog}
          >
            <Text fontFamily="sans-serif">Some content</Text>
          </Dialog>
        )}
      </>
    )
  }}
</State>

Props

Dialog

React.ReactNode

React.ReactNode

React.FunctionComponent<React.PropsWithChildren<DialogHeaderProps>>

React.FunctionComponent<React.PropsWithChildren<DialogProps>>

React.FunctionComponent<React.PropsWithChildren<DialogProps>>

DialogButtonProps[]

(gesture: 'close-button' | 'escape') => void

'dialog' | 'alertdialog'

'small' | 'medium' | 'large' | 'xlarge'

'small' | 'large' | 'auto'

DialogHeaderProps

The DialogHeaderProps interface extends DialogProps and adds these additional properties:

DialogButtonProps

The DialogButtonProps interface extends ButtonProps (see Button) and adds these additional properties:

ConfirmationDialog

A ConfirmationDialog is a special kind of dialog with more rigid behavior. It is used to confirm a user action. ConfirmationDialogs always have exactly two buttons: one to cancel the action and one to confirm it. No custom rendering capabilities are provided for ConfirmationDialog.

useConfirm hook

An alternate way to use ConfirmationDialog is with the useConfirm() hook. It takes no parameters and returns an async function, confirm. When confirm is called (see ConfirmOptions below for its argument), it shows the confirmation dialog. When the dialog is dismissed, a promise is resolved with true or false depending on whether or not the confirm button was used.

Example (with useConfirm hook)

function ShorthandExample2() {
  const confirm = useConfirm()
  const buttonClick = React.useCallback(
    async function (e) {
      if (await confirm({title: 'Are you sure?', content: 'You must confirm this action to continue.'})) {
        e.target.textContent = 'Confirmed!'
      }
    },
    [confirm],
  )
  return (
    <>
      <Button onClick={buttonClick}>Confirmable action</Button>
    </>
  )
}
render(<ShorthandExample2 />)

Example (using the full ConfirmationDialog component)

<State default={false}>
  {([isOpen, setIsOpen]) => {
    const openDialog = React.useCallback(() => setIsOpen(true), [setIsOpen])
    const closeDialog = React.useCallback(() => setIsOpen(false), [setIsOpen])
    return (
      <>
        <Button onClick={openDialog}>Open</Button>
        {isOpen && (
          <ConfirmationDialog title="Confirm action?" onClose={closeDialog}>
            Are you sure you want to confirm this action?
          </ConfirmationDialog>
        )}
      </>
    )
  }}
</State>

ConfirmationDialogProps

ConfirmOptions

Edit this page on GitHub

1 contributor

Last edited by broccolinisoup on March 13, 2023