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

anchor

children

classes

elevation

hideBackdrop

ModalProps

onClose

open

PaperProps

SlideProps

transitionDuration

variant

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.

.MuiDrawer-root

.MuiDrawer-docked

.MuiDrawer-paper

.MuiDrawer-paperAnchorLeft

.MuiDrawer-paperAnchorRight

.MuiDrawer-paperAnchorTop

.MuiDrawer-paperAnchorBottom

.MuiDrawer-paperAnchorDockedLeft

.MuiDrawer-paperAnchorDockedTop

.MuiDrawer-paperAnchorDockedRight

.MuiDrawer-paperAnchorDockedBottom

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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.