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/material/Drawer';
// or
import { Drawer } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

The props of the Modal component are available when variant="temporary" is set.

Props

Props of the native component are also available.

NameTypeDefaultDescription
anchor'bottom'
| 'left'
| 'right'
| 'top'		'left'

Side from which the drawer will appear.

childrennode

The content of the component.

classesobject

Override or extend the styles applied to the component.

See CSS API below for more details.

elevationinteger16

The elevation of the drawer.

hideBackdropboolfalse

If true, the backdrop is not rendered.

ModalPropsobject{}

Props applied to the Modal element.

onClosefunc

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".
openboolfalse

If true, the component is shown.

PaperPropsobject{}

Props applied to the Paper element.

SlidePropsobject

Props applied to the Slide element.

sxArray<func
| object
| bool>
| func
| object

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }		{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

variant'permanent'
| 'persistent'
| 'temporary'		'temporary'

The variant to use.

The ref is forwarded to the root element.

Theme default props

You can use MuiDrawer to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Global classRule nameDescription
.MuiDrawer-rootrootStyles applied to the root element.
.MuiDrawer-dockeddockedStyles applied to the root element if variant="permanent or persistent".
.MuiDrawer-paperpaperStyles applied to the Paper component.
.MuiDrawer-paperAnchorLeftpaperAnchorLeftStyles applied to the Paper component if anchor="left".
.MuiDrawer-paperAnchorRightpaperAnchorRightStyles applied to the Paper component if anchor="right".
.MuiDrawer-paperAnchorToppaperAnchorTopStyles applied to the Paper component if anchor="top".
.MuiDrawer-paperAnchorBottompaperAnchorBottomStyles applied to the Paper component if anchor="bottom".
.MuiDrawer-paperAnchorDockedLeftpaperAnchorDockedLeftStyles applied to the Paper component if anchor="left" and variant is not "temporary".
.MuiDrawer-paperAnchorDockedToppaperAnchorDockedTopStyles applied to the Paper component if anchor="top" and variant is not "temporary".
.MuiDrawer-paperAnchorDockedRightpaperAnchorDockedRightStyles applied to the Paper component if anchor="right" and variant is not "temporary".
.MuiDrawer-paperAnchorDockedBottompaperAnchorDockedBottomStyles applied to the Paper component if anchor="bottom" and variant is not "temporary".
.MuiDrawer-modalmodalStyles applied to the Modal component.

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