SwipeableDrawer API
API reference docs for the React SwipeableDrawer component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import SwipeableDrawer from '@mui/material/SwipeableDrawer';
// or
import { SwipeableDrawer } from '@mui/material';Props of the Drawer component are also available.
Callback fired when the component requests to be closed.
Type:func
function(event: React.SyntheticEvent<{}>) => voideventThe event source of the callback.
Callback fired when the component requests to be opened.
Type:func
function(event: React.SyntheticEvent<{}>) => voideventThe event source of the callback.
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).
Type:func
| bool
Default:false
Disable the backdrop transition. This can improve the FPS on low-end devices.
Type:bool
Default:false
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.
Type:bool
Default:false
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.
Type:bool
Default:typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)
Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer
Type:number
Default:0.52
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
Type:number
Default:450
The width of the left most (or right most) area in px that the drawer can be swiped open from.
Type:number
Default:20
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
Type:number
| { appear?: number, enter?: number, exit?: number }
Default:{
enter: theme.transitions.duration.enteringScreen,
exit: theme.transitions.duration.leavingScreen,
}
ref is forwarded to the root element.Inheritance
While not explicitly documented above, the props of the Drawer component are also available in SwipeableDrawer. You can take advantage of this to target nested components.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the root element if variant="permanent or persistent".
Rule name:docked
Styles applied to the Paper component if anchor="bottom".
Rule name:paperAnchorBottom
Styles applied to the Paper component if anchor="bottom" and variant is not "temporary".
Rule name:paperAnchorDockedBottom
Styles applied to the Paper component if anchor="left" and variant is not "temporary".
Rule name:paperAnchorDockedLeft
Styles applied to the Paper component if anchor="right" and variant is not "temporary".
Rule name:paperAnchorDockedRight
Styles applied to the Paper component if anchor="top" and variant is not "temporary".
Rule name:paperAnchorDockedTop
Styles applied to the Paper component if anchor="left".
Rule name:paperAnchorLeft
Styles applied to the Paper component if anchor="right".
Rule name:paperAnchorRight
Styles applied to the Paper component if anchor="top".
Rule name:paperAnchorTop
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
styleOverridesproperty in a custom theme.