Drawer

The Drawer component is a panel that slides out from the edge of the screen. It can be useful when you need users to complete a task or view some details without leaving the current page.

    SourceTheme source@chakra-ui/drawer

Theming#

The Drawer 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 Drawer component are:

  • variant: The visual variant of the Drawer. Defaults to baseStyle.
  • size: The size of the Drawer. 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 { drawerAnatomy 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 drawerTheme = defineMultiStyleConfig({
baseStyle,
})

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

import { extendTheme } from '@chakra-ui/react'
import { drawerTheme } from './components/theme/drawer'
export const theme = extendTheme({
components: { Drawer: drawerTheme },
})

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

Adding a custom size#

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

import { drawerAnatomy 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 drawerTheme = defineMultiStyleConfig({
sizes,
})
// Now we can use the new `xl` size
<Drawer 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 { drawerAnatomy 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 drawerTheme = defineMultiStyleConfig({
variants: { purple },
})
// Now we can use the new `purple` variant
<Drawer variant='purple' ... />

Changing the default properties#

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

import { drawerAnatomy as parts } from '@chakra-ui/anatomy'
import { createMultiStyleConfigHelpers } from '@chakra-ui/styled-system'
const { defineMultiStyleConfig } = createMultiStyleConfigHelpers(parts.keys)
export const drawerTheme = defineMultiStyleConfig({
defaultProps: {
size: 'xl',
variant: 'purple',
},
})
// This saves you time, instead of manually setting the size and variant every time you use a Drawer:
<Drawer size="xl" variant="purple" ... />

Showcase#

import {
    Drawer,
    DrawerBody,
    DrawerFooter,
    DrawerHeader,
    DrawerOverlay,
    DrawerContent,
    DrawerCloseButton,
    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 Drawer</Button>
  
        <Drawer isOpen={isOpen} onClose={onClose}>
          <DrawerOverlay />
          <DrawerContent>
            <DrawerHeader>Drawer Title</DrawerHeader>
            <DrawerCloseButton />
            <DrawerBody>
              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.
            </DrawerBody>
  
            <DrawerFooter>
              <Button colorScheme="blue" mr={3} onClick={onClose}>
                Close
              </Button>
              <Button variant="ghost">Secondary Action</Button>
            </DrawerFooter>
          </DrawerContent>
        </Drawer>
        <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