A dialog is a window overlaid on either the primary window or another dialog window. Content behind a modal dialog is inert, meaning that users cannot interact with it.
🚨 Version (v1.0.0) introduced a breaking change to this component's API. Kindly update accordingly.
Chakra exports 7 components to help you create any modal dialog.
Modal: The wrapper that provides context for its children.
ModalOverlay: The dimmed overlay behind the modal dialog.
ModalContent: The container for the modal dialog's content.
ModalHeader: The header that labels the modal dialog.
ModalFooter: The footer that houses the modal actions.
ModalBody: The wrapper that houses the modal's main content.
ModalCloseButton: The button that closes the modal.
When the modal opens, focus is sent into the modal and set to the first tabbable
element. If there are no tabbled elements, focus is set on
When the dialog closes, it returns focus to the element that triggered it. Set
finalFocusRef to change the element that should receive focus when the modal
For accessibility, it is recommended to block scrolling on the main document
behind the modal. Chakra does this by default but you can set
false to allow scrolling behind the modal.
Chakra automatically sets focus on the first tabbable element in the modal. However, there might be scenarios where you need to manually control where focus goes.
Chakra provides 2 props for this use case:
refof the component that receives focus when the modal opens.
refof the component that receives focus when the modal closes.
If you set
finalFocusRef, internally we set
falseso it doesn't return focus to the element that triggered it.
By default, the modal closes when you click its overlay. You can set
false if you want the modal to stay visible.
By default the modal has a vertical offset of
3.75rem which you can change by
top to the
ModalContent. If you need to vertically center the modal,
If the content within the modal overflows beyond the viewport, don't use this prop. Try setting the overflow behavior instead.
Modal comes with a scale transition by default but you can change it by
motionPreset prop, and set its value to either
If the content within the modal overflows beyond the viewport, you can use the
scrollBehavior to control how scrolling should happen.
inside, scroll only occurs within the
outside, the entire
ModalContentwill scroll within the viewport.
size prop if you need to adjust the size of the modal. Values can be
When the modal is open, it is rendered within a portal and all its siblings have
aria-hidden set to
true so the only thing screen readers see is the modal.
To disable this behavior, set
By default the modal, alert dialog and drawer locks the focus inside them. Normally this is what you want to maintain accessibility standards.
While strongly discourage this use case due to the accessibility impacts, there are certain situations where you might not want the modal to trap focus.
To prevent focus trapping, pass
trapFocus and set its value to
document.bodyto break it out of the source order and make it easy to add
aria-hiddento its siblings.
aria-labelledbyset to the
aria-describedbyset to the
|isOpen||If `true`, the modal when be opened.||-|
|onClose||Callback invoked to close the modal.||-|
|allowPinchZoom||Handle zoom/pinch gestures on iOS devices when scroll locking is enabled. Defaults to `false`.||-|
|autoFocus||If `true`, the modal will autofocus the first enabled and interactive element within the `ModalContent`|
|blockScrollOnMount||If `true`, scrolling will be disabled on the `body` when the modal opens.|
|closeOnEsc||If `true`, the modal will close when the `Esc` key is pressed|
|closeOnOverlayClick||If `true`, the modal will close when the overlay is clicked|
|finalFocusRef||The `ref` of element to receive focus when the modal closes.||-|
|getContainer||Function that will be called to get the parent element that the modal will be attached to.||-|
|id||The `id` of the modal||-|
|initialFocusRef||The `ref` of element to receive focus when the modal opens.||-|
|isCentered||If `true`, the modal will be centered on screen.|
|motionPreset||The transition that should be used for the modal||-|
|onEsc||Callback fired when the escape key is pressed and focus is within modal||-|
|onOverlayClick||Callback fired when the overlay is clicked.||-|
|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||-|
|returnFocusOnClose||If `true`, the modal will return focus to the element that triggered it when it closes.|
|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.|
|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.|
|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**|