Modal (Dialog)

A dialog is a window overlaid on either the primary window or another dialog window. Contents behind a modal dialog are inert meaning that users cannot interact with content behind the dialog.

🚨 Version (v0.3.2) introduced a breaking change to this component's API. Kindly update accordingly.

Import#

Chakra exports 8 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.

Usage#

When the modal opens, focus is sent into the modal and set to the first tabbable element. If there are no tabbled element, focus is set on the ModalContent.

Editable Example

Control Focus when Modal closes#

When the dialog closes, it returns focus to the element that triggered. Set finalFocusRef to element that should receive focus when the modal closes.

Some other content that'll receive focus on close.
Editable Example

Block Scrolling when Modal opens#

For accessibility, it's recommended to block scrolling on the main document behind the modal. Chakra does this by default but you can set blockScrollOnMount to false to allow scrolling behind modal.

Editable Example

Focus on specific element#

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:

  • initialFocusRef: The ref of the component that receives focus when the modal opens.
  • finalFocusRef: The ref of the component that receives focus when the modal closes.

If you set finalFocusRef, internally we set returnFocusOnClose to false so it doesn't return focus to the element that triggered it.

Editable Example

Close Modal on Overlay Click#

By default, the modal closes when you click it's overlay. You can set closeOnOverlayClick to false if you want the modal to stay visible.

Editable Example

Make modal vertically centered#

By default the modal has a vertical offset of 3.75rem which you can change by passing top to the ModalContent. If you need to vertically center the modal, pass the isCentered

If the content within the modal overflows beyond the viewport, don't use this prop. Try setting the overflow behavior instead

Editable Example

Adding transition#

The modal doesn't come with any transition by default so you can manage this yourself. Chakra exports two transition components SlideIn and Scale to provide simple transitions.

For some reason, focus doesn't return back to the trigger after the transition ends. As a walkaround, you might need to set finalFocusRef to the trigger or any other element, and set isOpen to true.

Editable Example

If the content within the modal overflows beyond the viewport, you can use the scrollBehavior to control how scrolling should happen.

  • If set to inside, scroll only occurs within the ModalBody.
  • If set to outside, the entire ModalContent will scroll within the viewport.
Editable Example

Pass the size prop if you need to adjust the size of the modal. Values can be xs, sm, md, lg, xl, or full.

Editable Example

Preserving the scrollbar gap#

By default, scrolling is blocked when the modal opens. This can lead to unpleasant content shift.

To prevent this, pass the preserveScrollBarGap prop. It applies a padding-right to the body element that's equal to the width of the browser's scrollbar.

Editable Example

Making other elements Inert#

When the modal is open, it's rendered within a portal and all it's siblings have aria-hidden set to true so the only thing screen readers see is the modal. To disable this behavior, set useInert to false.

Accessibility#

Keyboard and Focus Management#

  • When the modal opens, focus is trapped within it.
  • When the dialog opens, focus is automatically set to the first enabled element, or the element with the initialFocusRef.
  • When the modal closes, focus returns to the element that was focused just before the modal activated, or the element with the finalFocusRef
  • Clicking on the overlay closes the Modal.
  • Pressing Esc closes the Modal.
  • Scrolling is blocked on the elements behind the modal.
  • The modal is portalled to the end of document.body to break it out of the source order and make it easy to add aria-hidden to its siblings.

ARIA#

  • The ModalContent has aria-modal set to true.
  • The ModalContent has aria-labelledby set to the id of the ModalHeader
  • The ModalContent has aria-describedby set to the id of the ModalBody

Props#

NameTypeDefaultDescription
isOpenbooleanIf true, the modal will open
onClose(event, reason) => voidCallback invoked to close the modal.
isCenteredbooleanIf true, the Modal will be centered on screen
initialFocusRefReact.RefThe ref of the element to receive focus when the dialog opens
finalFocusRefReact.RefThe ref of element to receive focus when the dialog closes
blockScrollOnMountbooleantrueIf true, scrolling will be disabled on the body when the modal opens.
preserveScrollBarGapbooleanIf true, a padding-right will be applied to the body element to preserve the scrollbar gap.
useInertbooleantrueA11y: If true, all elements behing the Modal will have aria-hidden set to true so that screen readers can only see the Modal.
childrenReact.ReactNodeThe content of the modal.
sizeBoxProps["maxWidth"]mdThe size (maxWidth) of the modal.
scrollBehaviorinside, outsideoutsideWhere scroll behaviour should originate.
closeOnOverlayClickbooleantrueIf true, the modal will close when the overlay is clicked
returnFocusOnClosebooleantrueIf true, the modal will return focus to the element that triggered it when it closes.
closeOnEscbooleantrueIf true, the modal will close when the Esc key is pressed
addAriaLabelsboolean, {header: boolean, body: boolean}trueIf false, no aria-* properties will be added by default.
idstringThe id of the modal

Other components#

  • ModalOverlay, ModalHeader, ModalFooter and ModalBody composes Box component
  • ModalCloseButton composes CloseButton

Proudly made in 🇳🇬

Released under the MIT License.

Copyright © 2019 Segun Adebayo