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/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.

Component name

The name MuiDrawer can be used when providing default props or style overrides in the theme.

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.

Signature:
function(event: object) => void
event: The event source of the callback.
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.

CSS

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: