Skip to content
Edit this page

SwipeableDrawer API

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

Props

Props of the Drawer component are also available.

onCloseRequired

Callback fired when the component requests to be closed.

Type:

func

Signature:

function(event: object) => void
  • event The event source of the callback.
onOpenRequired

Callback fired when the component requests to be opened.

Type:

func

Signature:

function(event: object) => void
  • event The event source of the callback.
allowSwipeInChildren

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:

bool | func

Default:

false
children

The content of the component.

Type:

node
disableBackdropTransition

Disable the backdrop transition. This can improve the FPS on low-end devices.

Type:

bool

Default:

false
disableDiscovery

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
disableSwipeToOpen

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)
hysteresis

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
minFlingVelocity

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
open

If true, the component is shown.

Type:

bool

Default:

false
SwipeAreaProps

The element is used to intercept the touch events on the edge.

Type:

object
swipeAreaWidth

The width of the left most (or right most) area in px that the drawer can be swiped open from.

Type:

number

Default:

20
transitionDuration

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, }
The 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.