Alert Dialog

AlertDialog component is used to interrupt the user with a mandatory confirmation or action.

Import

Chakra UI exports 7 alert dialog related components.

• AlertDialog: provides context and state for the dialog.
• AlertDialogHeader: should contain the title announced by screen readers.
• AlertDialogBody: should contain the description announced by screen readers.
• AlertDialogFooter: should contain the actions of the dialog.
• AlertDialogOverlay: The dimmed overlay behind the dialog.
• AlertDialogContent: The wrapper for the alert dialog's content.
• AlertDialogCloseButton: The button that closes the dialog.

import {
  AlertDialog,
  AlertDialogBody,
  AlertDialogFooter,
  AlertDialogHeader,
  AlertDialogContent,
  AlertDialogOverlay,
} from "@chakra-ui/react";

Usage

AlertDialog requires that you provide the leastDestructiveRef prop.

Based on WAI-ARIA specifications, focus should be placed on the least destructive element when the dialog opens, to prevent users from accidentally confirming the destructive action.

function AlertDialogExample() { const { isOpen, onOpen, onClose } = useDisclosure(); const cancelRef = React.useRef(); return ( <> <Button colorScheme="red" onClick={onOpen}> Delete Customer </Button> <AlertDialog isOpen={isOpen} leastDestructiveRef={cancelRef} onClose={onClose} > <AlertDialogOverlay> <AlertDialogContent> <AlertDialogHeader fontSize="lg" fontWeight="bold"> Delete Customer </AlertDialogHeader> <AlertDialogBody> Are you sure? You can't undo this action afterwards. </AlertDialogBody> <AlertDialogFooter> <Button ref={cancelRef} onClick={onClose}> Cancel </Button> <Button colorScheme="red" onClick={onClose} ml={3}> Delete </Button> </AlertDialogFooter> </AlertDialogContent> </AlertDialogOverlay> </AlertDialog> </> ); }

function AlertDialogExample() {
  const { isOpen, onOpen, onClose } = useDisclosure();
  const cancelRef = React.useRef();

  return (
    <>
      <Button colorScheme="red" onClick={onOpen}>
        Delete Customer
      </Button>

      <AlertDialog
        isOpen={isOpen}
        leastDestructiveRef={cancelRef}
        onClose={onClose}
      >
        <AlertDialogOverlay>
          <AlertDialogContent>
            <AlertDialogHeader fontSize="lg" fontWeight="bold">
              Delete Customer
            </AlertDialogHeader>

            <AlertDialogBody>
              Are you sure? You can't undo this action afterwards.
            </AlertDialogBody>

            <AlertDialogFooter>
              <Button ref={cancelRef} onClick={onClose}>
                Cancel
              </Button>
              <Button colorScheme="red" onClick={onClose} ml={3}>
                Delete
              </Button>
            </AlertDialogFooter>
          </AlertDialogContent>
        </AlertDialogOverlay>
      </AlertDialog>
    </>
  );
}

Changing the transition

The Modal comes with a scale transition by default but you can change it by passing a motionPreset prop, and set its value to either slideInBottom, slideInRight, or scale.

function TransitionExample() { const { isOpen, onOpen, onClose } = useDisclosure(); const cancelRef = React.useRef(); return ( <> <Button onClick={onOpen}>Discard</Button> <AlertDialog motionPreset="slideInBottom" leastDestructiveRef={cancelRef} onClose={onClose} isOpen={isOpen} isCentered > <AlertDialogOverlay /> <AlertDialogContent> <AlertDialogHeader>Discard Changes?</AlertDialogHeader> <AlertDialogCloseButton /> <AlertDialogBody> Are you sure you want to discard all of your notes? 44 words will be deleted. </AlertDialogBody> <AlertDialogFooter> <Button ref={cancelRef} onClick={onClose}> No </Button> <Button colorScheme="red" ml={3}> Yes </Button> </AlertDialogFooter> </AlertDialogContent> </AlertDialog> </> ); }

function TransitionExample() {
  const { isOpen, onOpen, onClose } = useDisclosure();
  const cancelRef = React.useRef();

  return (
    <>
      <Button onClick={onOpen}>Discard</Button>
      <AlertDialog
        motionPreset="slideInBottom"
        leastDestructiveRef={cancelRef}
        onClose={onClose}
        isOpen={isOpen}
        isCentered
      >
        <AlertDialogOverlay />

        <AlertDialogContent>
          <AlertDialogHeader>Discard Changes?</AlertDialogHeader>
          <AlertDialogCloseButton />
          <AlertDialogBody>
            Are you sure you want to discard all of your notes? 44 words will be
            deleted.
          </AlertDialogBody>
          <AlertDialogFooter>
            <Button ref={cancelRef} onClick={onClose}>
              No
            </Button>
            <Button colorScheme="red" ml={3}>
              Yes
            </Button>
          </AlertDialogFooter>
        </AlertDialogContent>
      </AlertDialog>
    </>
  );
}

Accessibility

• AlertDialog has role alertdialog, and aria-modal set to true.
• When the dialog opens, focus is automatically set to the least destructive element.
• When the dialog opens, the content in the AlertDialogHeader and AlertDialogBody are announced by screen readers via aria-labelledby and aria-describedby attributes.
• Clicking on the overlay closes the AlertDialog.
• Pressing esc closes the dialog.

Props

AlertDialog and its components compose the Modal component. The only exception is that it requires a leastDestructiveRef which is similar to the initialFocusRef of Modal.

isOpenrequired

Description

If true, the modal will be open.

Type

boolean

leastDestructiveRefrequired

Type

RefObject<FocusableElement>

onCloserequired

Description

Callback invoked to close the modal.

Type

() => void

allowPinchZoom

Description

Handle zoom/pinch gestures on iOS devices when scroll locking is enabled.

Type

boolean

Default

false.

autoFocus

Description

If true, the modal will autofocus the first enabled and interactive element within the ModalContent

Type

boolean

Default

true

blockScrollOnMount

Description

If true, scrolling will be disabled on the body when the modal opens.

Type

boolean

Default

true

closeOnEsc

Description

If true, the modal will close when the Esc key is pressed

Type

boolean

Default

true

closeOnOverlayClick

Description

If true, the modal will close when the overlay is clicked

Type

boolean

Default

true

colorScheme

Description

Color Schemes for AlertDialog are not implemented in the default theme. You can extend the theme to implement them.

Type

string

finalFocusRef

Description

The ref of element to receive focus when the modal closes.

Type

RefObject<FocusableElement>

id

Description

The id of the modal

Type

string

isCentered

Description

If true, the modal will be centered on screen.

Type

boolean

Default

false

lockFocusAcrossFrames

Description

Enables aggressive focus capturing within iframes. - If true: keep focus in the lock, no matter where lock is active - If false: allows focus to move outside of iframe

Type

boolean

motionPreset

Description

The transition that should be used for the modal

Type

MotionPreset

Default

"scale"

onCloseComplete

Description

Fires when all exiting nodes have completed animating out

Type

(() => void)

onEsc

Description

Callback fired when the escape key is pressed and focus is within modal

Type

(() => void)

onOverlayClick

Description

Callback fired when the overlay is clicked.

Type

(() => void)

portalProps

Description

Props to be forwarded to the portal component

Type

Pick<PortalProps, "appendToParentPortal" | "containerRef">

preserveScrollBarGap

Description

If true, a `padding-right` will be applied to the body element that's equal to the width of the scrollbar. This can help prevent some unpleasant flickering effect and content adjustment when the modal opens

Type

boolean

returnFocusOnClose

Description

If true, the modal will return focus to the element that triggered it when it closes.

Type

boolean

Default

true

size

Type

"xs" | "sm" | "md" | "lg" | "xl" | "2xl" | "3xl" | "4xl" | "5xl" | "6xl" | "full"

Default

"md"

trapFocus

Description

If false, focus lock will be disabled completely. This is useful in situations where you still need to interact with other surrounding elements. 🚨Warning: We don't recommend doing this because it hurts the accessibility of the modal, based on WAI-ARIA specifications.

Type

boolean

Default

true

useInert

Description

A11y: If true, the siblings of the modal will have `aria-hidden` set to true so that screen readers can only see the modal. This is commonly known as making the other elements **inert**

Type

boolean

Default

true

variant

Description

Variants for AlertDialog are not implemented in the default theme. You can extend the theme to implement them.

Type

string