Modal

A modal is a dialog that focuses the user's attention exclusively on an information via a window that is overlaid on primary content.

    SourceTheme source@chakra-ui/modal

The Modal component is a multipart component.

To learn more about styling multipart components, visit the Component Style page.

Anatomy#

  • A: header
  • B: overlay
  • C: dialogContainer
  • D: dialog
  • E: closeButton
  • F: body
  • G: footer

You can find more information in the source here.

Theming properties#

The properties that affect the theming of the Modal component are:

  • variant: The visual variant of the Modal. Defaults to baseStyle.
  • size: The size of the Modal. Defaults to md.

Theming utilities#

  • createMultiStyleConfigHelpers: a function that returns a set of utilities for creating style configs for a multipart component (definePartsStyle and defineMultiStyleConfig).
  • definePartsStyle: a function used to create multipart style objects.
  • defineMultiStyleConfig: a function used to define the style configuration for a multipart component.

Customizing the default theme#

import { modalAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/styled-system'


const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)


const baseStyle = definePartsStyle({
  // define the part you're going to style
  overlay: {
    bg: 'blackAlpha.200', //change the background
  },
  dialog: {
    borderRadius: 'md',
    bg: `purple.100`,
  },
})


export const modalTheme = defineMultiStyleConfig({
  baseStyle,
})

After customizing the modal theme, we can import it in our theme file and add it in the components property:

import { extendTheme } from '@chakra-ui/react'
import { modalTheme } from './components/theme/modal'


export const theme = extendTheme({
  components: { Modal: modalTheme },
})

This is a crucial step to make sure that any changes that we make to the Modal theme are applied.

Adding a custom size

Let's assume we want to change the font size of both header and dialog.

import { modalAnatomy as parts } from '@chakra-ui/anatomy'
import {
  createMultiStyleConfigHelpers,
  defineStyle,
} from '@chakra-ui/styled-system'


const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)


const xl = defineStyle({
  px: '6',
  py: '2',
  fontSize: 'xl',
})


const sm = defineStyle({
  fontSize: 'sm',
  py: '6',
})


const sizes = {
  xl: definePartsStyle({ header: sm, dialog: xl }),
}


export const modalTheme = defineMultiStyleConfig({
  sizes,
})


// Now we can use the new `xl` size
<Modal size="xl" ... />

Every time you're adding anything new to the theme, you'd need to run the CLI command to get proper autocomplete in your IDE. You can learn more about the CLI tool here.

Adding a custom variant#

Let's assume we want to include a custom variant. Here's how we can do that:

import { modalAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/styled-system'


const { definePartsStyle, defineMultiStyleConfig } =
  createMultiStyleConfigHelpers(parts.keys)


const purple = definePartsStyle({
  dialog: {
    borderRadius: 'md',
    bg: `purple.100`,


    // Let's also provide dark mode alternatives
    _dark: {
      bg: `purple.600`,
      color: 'white',
    },
  },
})


export const modalTheme = defineMultiStyleConfig({
  variants: { purple },
})


// Now we can use the new `purple` variant
<Modal variant='purple' ... />

Changing the default properties#

Let's assume we want to change the default size and variant of every Modal in our app.

import { modalAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/styled-system'


const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(parts.keys)


export const modalTheme = defineMultiStyleConfig({
  defaultProps: {
    size: 'xl',
    variant: 'purple',
  },
})


// This saves you time, instead of manually setting the size and variant every time you use an Modal:
<Modal size="xl" variant="purple" ... />

Showcase#

import {
  Modal,
  ModalOverlay,
  ModalContent,
  ModalHeader,
  ModalFooter,
  ModalBody,
  ModalCloseButton,
  useDisclosure,
  Button,
  Box,
  IconButton,
  useColorMode,
} from "@chakra-ui/react";
import { FaMoon, FaSun } from "react-icons/fa";


export default function App() {
  const { isOpen, onOpen, onClose } = useDisclosure();
  const { toggleColorMode, colorMode } = useColorMode();

  return (
      <Box position="relative" h="100vh" p={12}>
      <Button onClick={onOpen}>Open Modal</Button>

      <Modal isOpen={isOpen} onClose={onClose}>
        <ModalOverlay />
        <ModalContent>
          <ModalHeader>Modal Title</ModalHeader>
          <ModalCloseButton />
          <ModalBody>
            Lorem ipsum dolor sit amet. Et corporis quisquam eum adipisci
            impedit quo eius nisi est aspernatur vel veniam velit qui numquam
            totam. Vel debitis sint ut culpa cupiditate a dolores voluptates ut
            vero voluptatem non rerum aliquid qui sapiente possimus. Eum natus
            voluptates hic galisum architecto et nobis incidunt ut odio ipsum
            qui repudiandae voluptatem.
          </ModalBody>

          <ModalFooter>
            <Button colorScheme="blue" mr={3} onClick={onClose}>
              Close
            </Button>
            <Button variant="ghost">Secondary Action</Button>
          </ModalFooter>
        </ModalContent>
      </Modal>
      <IconButton
        aria-label="change theme"
        rounded="full"
        size="xs"
        position="absolute"
        bottom={4}
        left={4}
        onClick={toggleColorMode}
        icon={colorMode === "dark" ? <FaSun /> : <FaMoon />}
      />
    </Box>
  );
}
Edit this page on GitHub

Proudly made inNigeria by Segun Adebayo

Deployed by â–² Vercel