Skip to content

Drawer API

API reference docs for the React Drawer component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Drawer from '@mui/joy/Drawer';
// or
import { Drawer } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

The navigation drawers (or "sidebars") provide ergonomic access to destinations in a site or app functionality such as switching accounts.

Props

Props of the native component are also available.

openRequired
anchor
color
component
container
disableAutoFocus
disableEnforceFocus
disableEscapeKeyDown
disablePortal
disableRestoreFocus
disableScrollLock
hideBackdrop
invertedColors
onClose
size
slotProps
slots
variant
The ref is forwarded to the root element.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

root
backdrop
content

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiDrawer-colorContext
.MuiDrawer-colorDanger
.MuiDrawer-colorNeutral
.MuiDrawer-colorPrimary
.MuiDrawer-colorSuccess
.MuiDrawer-colorWarning
.MuiDrawer-hidden
.MuiDrawer-sizeLg
.MuiDrawer-sizeMd
.MuiDrawer-sizeSm
.MuiDrawer-variantOutlined
.MuiDrawer-variantPlain
.MuiDrawer-variantSoft
.MuiDrawer-variantSolid