Skip to content

SwipeableDrawer API

API reference docs for the React SwipeableDrawer 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 SwipeableDrawer from '@mui/material/SwipeableDrawer';
// or
import { SwipeableDrawer } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.


Props of the Drawer component are also available.

Callback fired when the component requests to be closed.

function(event: object) => void
event: The event source of the callback.
Callback fired when the component requests to be opened.

function(event: object) => void
event: The event source of the callback.
| func
If set to true, the swipe event will open the drawer even if the user begins the swipe on one of the drawer's children. This can be useful in scenarios where the drawer is partially visible. You can customize it further with a callback that determines which children the user can drag over to open the drawer (for example, to ignore other elements that handle touch move events, like sliders).
The content of the component.
Disable the backdrop transition. This can improve the FPS on low-end devices.
If true, touching the screen near the edge of the drawer will not slide in the drawer a bit to promote accidental discovery of the swipe gesture.
disableSwipeToOpenbooltypeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)
If true, swipe to open is disabled. This is useful in browsers where swiping triggers navigation actions. Swipe to open is disabled on iOS browsers by default.
Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer
Defines, from which (average) velocity on, the swipe is defined as complete although hysteresis isn't reached. Good threshold is between 250 - 1000 px/s
If true, the component is shown.
The element is used to intercept the touch events on the edge.
The width of the left most (or right most) area in px that the drawer can be swiped open from.
| { 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.

The ref is forwarded to the root element.


While not explicitly documented above, the props of the Drawer component are also available on SwipeableDrawer. You can take advantage of this to target nested components.