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:

Drawer

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.

Name	Type	Default	Description
open*	bool	-	If `true`, the component is shown.
anchor	'bottom' \| 'left' \| 'right' \| 'top'	'left'	Side from which the drawer will appear.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
container	HTML element \| func	-	An HTML element or function that returns one. The `container` will have the portal children appended to it. You can also provide a callback, which is called in a React layout effect. This lets you set the container from a ref, and also makes server-side rendering possible. By default, it uses the body of the top-level document object, so it's simply `document.body` most of the time.
disableAutoFocus	bool	false	If `true`, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the `disableAutoFocus` prop. Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers.
disableEnforceFocus	bool	false	If `true`, the modal will not prevent focus from leaving the modal while open. Generally this should never be set to `true` as it makes the modal less accessible to assistive technologies, like screen readers.
disableEscapeKeyDown	bool	false	If `true`, hitting escape will not fire the `onClose` callback.
disablePortal	bool	false	The `children` will be under the DOM hierarchy of the parent component.
disableRestoreFocus	bool	false	If `true`, the modal will not restore focus to previously focused element once modal is hidden or unmounted.
disableScrollLock	bool	false	Disable the scroll lock behavior.
hideBackdrop	bool	false	If `true`, the backdrop is not rendered.
invertedColors	bool	false	If `true`, the children with an implicit color prop invert their colors to match the component's variant and color.
onClose	func	-	Callback fired when the component requests to be closed. The `reason` parameter can optionally be used to control the response to `onClose`. Signature:`function(event: object, reason: string) => void` `event` The event source of the callback. `reason` Can be: `"escapeKeyDown"`, `"backdropClick"`, `"closeClick"`.
size	'sm' \| 'md' \| 'lg'	'md'	The size of the component. To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ backdrop?: func \| object, content?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ backdrop?: elementType, content?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid'	'plain'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Slots

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

Slot name	Class name	Default component	Description
root	.MuiDrawer-root	`'div'`	The component that renders the root.
backdrop	.MuiDrawer-backdrop	`'div'`	The component that renders the backdrop.
content	.MuiDrawer-content	`'div'`	The component that renders the content of the drawer.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiDrawer-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiDrawer-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiDrawer-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiDrawer-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiDrawer-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiDrawer-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiDrawer-hidden	hidden	Class name applied to the root element when open is false.
.MuiDrawer-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiDrawer-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiDrawer-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiDrawer-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiDrawer-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiDrawer-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiDrawer-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.

You can override the style of the component using one of these customization options:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.