AlertDialog

AlertDialogs are a specific type of Dialog. They display important information that users need to acknowledge.

installyarn add @react-spectrum/dialog
version3.0.0-alpha.1
usageimport {AlertDialog} from '@react-spectrum/dialog'
View guidelines
Spectrum
View repository
GitHub
View package
NPM

Example#

<DialogTrigger>
  <ActionButton>Save</ActionButton>
  <AlertDialog title="Low Disk Space" variant="warning" primaryActionLabel="Confirm">
    You are running low on disk space. Delete unnecessary files to free up space.
  </AlertDialog>
</DialogTrigger>

Content#

Unlike Dialog, the layout in AlertDialog is very deliberate. The body of an AlertDialog can be provided by passing children to the component. The AlertDialog also supports having up to three buttons in its footer: a primary button, a secondary button, and a cancel button. Each button can be rendered by providing a string to the primaryActionLabel, secondaryActionLabel, and cancelLabel respectively. Be sure to localize any strings provided to the AlertDialog and to the button labels as well. 

<DialogTrigger>
  <ActionButton>Exit</ActionButton>
  <AlertDialog variant="information" title="Register profile" primaryActionLabel="Register" secondaryActionLabel="Remind me later" cancelLabel="Cancel">
    You have not saved your profile information for this account. Would you like to register now?
  </AlertDialog>
</DialogTrigger>

Accessibility#

If any of the buttons in the ActionDialog's footer should be focused on render, specify which one via the autoFocusButton prop.

<DialogTrigger>
  <ActionButton>Save</ActionButton>
  <AlertDialog variant="confirmation" title="Save file" primaryActionLabel="Save" cancelLabel="Cancel" autoFocusButton="primary">
    A file with the same name already exists. Overwrite?
  </AlertDialog>
</DialogTrigger>

Labeling#

ActionDialogs should always have a visible title, specified by passing a string as the title prop. This string should be localized so that the ActionDialog is properly internationalized.

Events#

AlertDialog accepts an onPrimaryAction, onSecondaryAction and onCancel prop, triggered when the AlertDialog's confirm or cancel buttons are clicked respectively.

The example below uses onPrimaryAction, onSecondaryAction and onCancel to tell the user which button was clicked to close the AlertDialog.

function Example() {
  let onPrimaryAction = () => alert('Primary button clicked.');
  let onSecondaryAction = () => alert('Secondary button clicked.');
  let alertCancel = () => alert('Cancel button clicked.');

  return (
    <DialogTrigger>
      <ActionButton>
        Publish
      </ActionButton>
      <AlertDialog
        variant="confirmation" 
        title="Confirm Publish" 
        primaryActionLabel="Publish" 
        secondaryActionLabel="Save as draft" 
        cancelLabel="Cancel"
        onCancel={alertCancel}
        onPrimaryAction={onPrimaryAction}
        onSecondaryAction={onSecondaryAction}>
        Are you sure you want to publish this document?
      </AlertDialog>
    </DialogTrigger>
  );
}

Props#

NameTypeDefaultDescription
variant'confirmation' | 'information' | 'destructive' | 'error' | 'warning'—The visual style of the AlertDialog.
titlestring—The title of the AlertDialog.
childrenReactNode—The contents of the AlertDialog.
cancelLabelstring—The label to display within the cancel button.
primaryActionLabelstring—The label to display within the confirm button.
secondaryActionLabelstring—The label to display within the secondary button.
isPrimaryActionDisabledboolean—Whether the primary button is disabled.
isSecondaryActionDisabledboolean—Whether the secondary button is disabled.
autoFocusButton'cancel' | 'primary' | 'secondary'—Button to focus by default upon render.
Events
NameTypeDefaultDescription
onCancel() => void—Handler that is called when the cancel button is pressed.
onPrimaryAction() => void—Handler that is called when the primary button is pressed.
onSecondaryAction() => void—Handler that is called when the secondary button is pressed.
Layout
NameTypeDefaultDescription
flexstring | number | boolean—When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumber—When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumber—When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumber | string—When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'auto' | 'normal' | 'start' | 'end' | 'center' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'stretch'—Overrides the alignItems property of a flex or grid container. See MDN.
justifySelf'auto' | 'normal' | 'start' | 'end' | 'flex-start' | 'flex-end' | 'self-start' | 'self-end' | 'center' | 'left' | 'right' | 'stretch'—Specifies how the element is justified inside a flex or grid container. See MDN.
ordernumber—The layout order for the element within a flex or grid container. See MDN.
gridAreastring—When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstring—When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstring—When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstring—When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstring—When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstring—When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstring—When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValue—The margin for all four sides of the element. See MDN.
marginTopDimensionValue—The margin for the top side of the element. See MDN.
marginBottomDimensionValue—The margin for the bottom side of the element. See MDN.
marginStartDimensionValue—The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValue—The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValue—The margin for both the left and right sides of the element. See MDN.
marginYDimensionValue—The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValue—The width of the element. See MDN.
minWidthDimensionValue—The minimum width of the element. See MDN.
maxWidthDimensionValue—The maximum width of the element. See MDN.
heightDimensionValue—The height of the element. See MDN.
minHeightDimensionValue—The minimum height of the element. See MDN.
maxHeightDimensionValue—The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static' | 'relative' | 'absolute' | 'fixed' | 'sticky'—Specifies how the element is positioned. See MDN.
topDimensionValue—The top position for the element. See MDN.
bottomDimensionValue—The bottom position for the element. See MDN.
leftDimensionValue—The left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValue—The right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValue—The logical start position for the element, depending on layout direction. See MDN.
endDimensionValue—The logical end position for the element, depending on layout direction. See MDN.
zIndexnumber—The stacking order for the element. See MDN.
isHiddenboolean—Hides the element.
Accessibility
NameTypeDefaultDescription
rolestring—
idstring—
tabIndexnumber—
aria-labelstring—Defines a string value that labels the current element.
aria-labelledbystring—Identifies the element (or elements) that labels the current element.
aria-describedbystring—Identifies the element (or elements) that describes the object.
aria-controlsstring—Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-ownsstring—Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-hiddenboolean | 'false' | 'true'—Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestring—Sets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSProperties—Sets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#

Variant#

View guidelines

<DialogTrigger marginEnd="20px">
  <ActionButton>Exit</ActionButton>
  <AlertDialog variant="confirmation" title="Exit instance?" primaryActionLabel="Confirm" cancelLabel="Cancel">
    Exit dungeon instance and return to main hub?
  </AlertDialog>
</DialogTrigger>

<DialogTrigger marginEnd="20px">
  <ActionButton>New file</ActionButton>
  <AlertDialog variant="information" title="Connect your account" primaryActionLabel="Continue" cancelLabel="Cancel">
    Please connect an existing account to sync any new files.
  </AlertDialog>
</DialogTrigger>

<DialogTrigger marginEnd="20px">
  <ActionButton>Delete</ActionButton>
  <AlertDialog variant="destructive" title="Delete file" primaryActionLabel="Delete" cancelLabel="Cancel">
    This will permanently delete the selected file. Continue?
  </AlertDialog>
</DialogTrigger>

<DialogTrigger marginEnd="20px">
  <ActionButton>Login</ActionButton>
  <AlertDialog variant="error" title="Unable to connect" primaryActionLabel="Retry" cancelLabel="Cancel">
    Something went wrong while connecting to the server. Please try again in a couple minutes.
  </AlertDialog>
</DialogTrigger>

<DialogTrigger>
  <ActionButton>Enter</ActionButton>
  <AlertDialog variant="warning" title="Raid instance" primaryActionLabel="Confirm" cancelLabel="Cancel">
    The following encounter meant for parties of 4 or more. Enter anyways?
  </AlertDialog>
</DialogTrigger>

Primary action disabled#

Disables the primary button.

<DialogTrigger>
  <ActionButton>Upgrade</ActionButton>
  <AlertDialog isPrimaryActionDisabled variant="confirmation" title="Upgrade subscription" primaryActionLabel="Upgrade" cancelLabel="Cancel">
    Upgrade subscription for an additional $14.99 a month?
  </AlertDialog>
</DialogTrigger>

Secondary action disabled#

Disables the secondary button.

<DialogTrigger>
  <ActionButton>Upgrade</ActionButton>
  <AlertDialog isSecondaryActionDisabled variant="confirmation" title="Upgrade subscription" primaryActionLabel="Upgrade" secondaryActionLabel="Apply Coupon" cancelLabel="Cancel">
    Upgrade subscription for an additional $14.99 a month?
  </AlertDialog>
</DialogTrigger>