Skip to content
Edit this page

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

If true, the component is shown.

Type:

bool
anchor

Side from which the drawer will appear.

Type:

'bottom' | 'left' | 'right' | 'top'

Default:

'left'
color

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning'

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
container

An HTML element or function that returns one. The container will have the portal children appended to it.
By default, it uses the body of the top-level document object, so it's simply document.body most of the time.

Type:

HTML element | func
disableAutoFocus

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.

Type:

bool

Default:

false
disableEnforceFocus

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.

Type:

bool

Default:

false
disableEscapeKeyDown

If true, hitting escape will not fire the onClose callback.

Type:

bool

Default:

false
disablePortal

The children will be under the DOM hierarchy of the parent component.

Type:

bool

Default:

false
disableRestoreFocus

If true, the modal will not restore focus to previously focused element once modal is hidden or unmounted.

Type:

bool

Default:

false
disableScrollLock

Disable the scroll lock behavior.

Type:

bool

Default:

false
hideBackdrop

If true, the backdrop is not rendered.

Type:

bool

Default:

false
invertedColors

If true, the children with an implicit color prop invert their colors to match the component's variant and color.

Type:

bool

Default:

false
onClose

Callback fired when the component requests to be closed. The reason parameter can optionally be used to control the response to onClose.

Type:

func

Signature:

function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "escapeKeyDown", "backdropClick", "closeClick".
size

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

Type:

'sm' | 'md' | 'lg'

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ backdrop?: func | object, content?: func | object, root?: func | object }

Default:

{}
slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ backdrop?: elementType, content?: elementType, root?: elementType }

Default:

{}
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid'

Default:

'plain'
The ref is forwarded to the root element.

Slots

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

root

The component that renders the root.

Default: 'div'

Global class: .MuiDrawer-root

backdrop

The component that renders the backdrop.

Default: 'div'

Global class: .MuiDrawer-backdrop

content

The component that renders the content of the drawer.

Default: 'div'

Global class: .MuiDrawer-content

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

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

Class name applied to the root element when color inversion is triggered.

.MuiDrawer-colorDanger

Class name applied to the root element if color="danger".

.MuiDrawer-colorNeutral

Class name applied to the root element if color="neutral".

.MuiDrawer-colorPrimary

Class name applied to the root element if color="primary".

.MuiDrawer-colorSuccess

Class name applied to the root element if color="success".

.MuiDrawer-colorWarning

Class name applied to the root element if color="warning".

.MuiDrawer-hidden

Class name applied to the root element when open is false.

.MuiDrawer-sizeLg

Class name applied to the root element if size="lg".

.MuiDrawer-sizeMd

Class name applied to the root element if size="md".

.MuiDrawer-sizeSm

Class name applied to the root element if size="sm".

.MuiDrawer-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiDrawer-variantPlain

Class name applied to the root element if variant="plain".

.MuiDrawer-variantSoft

Class name applied to the root element if variant="soft".

.MuiDrawer-variantSolid

Class name applied to the root element if variant="solid".