SwipeableDrawerProps
Properties
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).
Side from which the drawer will appear.
A backdrop component. This prop enables custom backdrop rendering.
Props applied to the /material-ui/api/backdrop/ element.
Override or extend the styles applied to the component.
When set to true the Modal waits until a nested Transition is completed before closing.
The components used for each slot inside.
The extra props for the slot components. You can override the existing props or add new ones.
If true
, the modal will not automatically shift focus to itself when it opens, and replace it to the last focused element when it closes. This also works correctly with any modal children that have the disableAutoFocus
prop.
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.
If true
, the modal will not prevent focus from leaving the modal while open.
If true
, hitting escape will not fire the onClose
callback.
The children
will be under the DOM hierarchy of the parent component.
If true
, the modal will not restore focus to previously focused element once modal is hidden or unmounted.
Disable the scroll lock behavior.
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.
If true
, the backdrop is not rendered.
Affects how far the drawer must be opened/closed to change its state. Specified as percent (0-1) of the width of the drawer
Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Modal.
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
Props applied to the /material-ui/api/modal/ element.
Callback fired when the backdrop is clicked.
Callback fired when the component requests to be closed.
Callback fired when the component requests to be opened.
A function called when a transition enters.
A function called when a transition has exited.
Props applied to the /material-ui/api/paper/ element.
Props applied to the /material-ui/api/slide/ element.
The props used for each slot inside the Modal.
The components used for each slot inside the Modal. Either a string to use a HTML element or a component.
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.
The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.
The variant to use.