If true
, the modal will be open.
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, setIsOpen] = React.useState(false)const onClose = () => setIsOpen(false)const cancelRef = React.useRef()return (<><Button colorScheme='red' onClick={() => setIsOpen(true)}>Delete Customer</Button><AlertDialogisOpen={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><AlertDialogmotionPreset='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 bedeleted.</AlertDialogBody><AlertDialogFooter><Button ref={cancelRef} onClick={onClose}>No</Button><Button colorScheme='red' ml={3}>Yes</Button></AlertDialogFooter></AlertDialogContent></AlertDialog></>)}
Accessibility#
AlertDialog
has rolealertdialog
, andaria-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
andAlertDialogBody
are announced by screen readers viaaria-labelledby
andaria-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
.
isOpen
required
isOpen
required
boolean
leastDestructiveRef
required
leastDestructiveRef
required
RefObject<FocusableElement> | undefined
onClose
required
onClose
required
Callback invoked to close the modal.
() => void
allowPinchZoom
allowPinchZoom
Handle zoom/pinch gestures on iOS devices when scroll locking is enabled.
Defaults to false
.
boolean
autoFocus
autoFocus
If true
, the modal will autofocus the first enabled and interactive
element within the ModalContent
boolean
true
blockScrollOnMount
blockScrollOnMount
If true
, scrolling will be disabled on the body
when the modal opens.
boolean
true
closeOnEsc
closeOnEsc
If true
, the modal will close when the Esc
key is pressed
boolean
true
closeOnOverlayClick
closeOnOverlayClick
If true
, the modal will close when the overlay is clicked
boolean
true
colorScheme
colorScheme
Color Schemes for AlertDialog
are not implemented in the default theme. You can extend the theme to implement them.
string
finalFocusRef
finalFocusRef
The ref
of element to receive focus when the modal closes.
RefObject<FocusableElement>
id
id
The id
of the modal
string
isCentered
isCentered
If true
, the modal will be centered on screen.
boolean
false
lockFocusAcrossFrames
lockFocusAcrossFrames
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
boolean
motionPreset
motionPreset
The transition that should be used for the modal
MotionPreset
onEsc
onEsc
Callback fired when the escape key is pressed and focus is within modal
(() => void)
onOverlayClick
onOverlayClick
Callback fired when the overlay is clicked.
(() => void)
portalProps
portalProps
Props to be forwarded to the portal component
Pick<PortalProps, "appendToParentPortal" | "containerRef">
preserveScrollBarGap
preserveScrollBarGap
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
boolean
returnFocusOnClose
returnFocusOnClose
If true
, the modal will return focus to the element that triggered it when it closes.
boolean
true
scrollBehavior
scrollBehavior
Where scroll behavior should originate.
- If set to inside
, scroll only occurs within the ModalBody
.
- If set to outside
, the entire ModalContent
will scroll within the viewport.
ScrollBehavior
"outside"
size
size
string
"md"
trapFocus
trapFocus
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.
boolean
true
useInert
useInert
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**
boolean
true
variant
variant
string