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.


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


import Drawer from '@mui/material/Drawer';
// or
import { Drawer } from '@mui/material';
You can 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 of the native component are also available.

| 'left'
| 'right'
| 'top'
Side from which the drawer will appear.
The content of the component.
Override or extend the styles applied to the component. See CSS API below for more details.
The elevation of the drawer.
If true, the backdrop is not rendered.
Props applied to the Modal element.
Callback fired when the component requests to be closed.

function(event: object) => void
event: The event source of the callback.
If true, the component is shown.
Props applied to the Paper element.
Props applied to the Slide element.
| 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.
| { 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.
| 'persistent'
| '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.


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

Rule nameGlobal classDescription
root.MuiDrawer-rootStyles applied to the root element.
docked.MuiDrawer-dockedStyles applied to the root element if variant="permanent or persistent".
paper.MuiDrawer-paperStyles applied to the Paper component.
paperAnchorLeft.MuiDrawer-paperAnchorLeftStyles applied to the Paper component if anchor="left".
paperAnchorRight.MuiDrawer-paperAnchorRightStyles applied to the Paper component if anchor="right".
paperAnchorTop.MuiDrawer-paperAnchorTopStyles applied to the Paper component if anchor="top".
paperAnchorBottom.MuiDrawer-paperAnchorBottomStyles applied to the Paper component if anchor="bottom".
paperAnchorDockedLeft.MuiDrawer-paperAnchorDockedLeftStyles applied to the Paper component if anchor="left" and variant is not "temporary".
paperAnchorDockedTop.MuiDrawer-paperAnchorDockedTopStyles applied to the Paper component if anchor="top" and variant is not "temporary".
paperAnchorDockedRight.MuiDrawer-paperAnchorDockedRightStyles applied to the Paper component if anchor="right" and variant is not "temporary".
paperAnchorDockedBottom.MuiDrawer-paperAnchorDockedBottomStyles applied to the Paper component if anchor="bottom" and variant is not "temporary".
modal.MuiDrawer-modalStyles applied to the Modal component.

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