Page MenuHomec4science
Files F100944899

SwipeableDrawer.d.ts
No OneTemporary
Actions

File Metadata

Created
Tue, Feb 4, 04:43

SwipeableDrawer.d.ts
View Options

import * as React from 'react';
import { DrawerProps } from '../Drawer';
export interface SwipeableDrawerProps extends Omit<DrawerProps, 'onClose' | 'open'> {
/**
* Disable the backdrop transition.
* This can improve the FPS on low-end devices.
* @default false
*/
disableBackdropTransition?: boolean;
/**
* 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.
* @default false
*/
disableDiscovery?: boolean;
/**
* 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.
* @default typeof navigator !== 'undefined' && /iPad|iPhone|iPod/.test(navigator.userAgent)
*/
disableSwipeToOpen?: boolean;
/**
* Affects how far the drawer must be opened/closed to change its state.
* Specified as percent (0-1) of the width of the drawer
* @default 0.52
*/
hysteresis?: number;
/**
* 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
* @default 450
*/
minFlingVelocity?: number;
/**
* Callback fired when the component requests to be closed.
*
* @param {React.SyntheticEvent<{}>} event The event source of the callback.
*/
onClose: React.ReactEventHandler<{}>;
/**
* Callback fired when the component requests to be opened.
*
* @param {React.SyntheticEvent<{}>} event The event source of the callback.
*/
onOpen: React.ReactEventHandler<{}>;
/**
* If `true`, the component is shown.
* @default false
*/
open?: boolean;
/**
* The element is used to intercept the touch events on the edge.
*/
SwipeAreaProps?: object;
/**
* The width of the left most (or right most) area in `px` that
* the drawer can be swiped open from.
* @default 20
*/
swipeAreaWidth?: number;
}
/**
*
* Demos:
*
* - [Drawer](https://mui.com/material-ui/react-drawer/)
*
* API:
*
* - [SwipeableDrawer API](https://mui.com/material-ui/api/swipeable-drawer/)
* - inherits [Drawer API](https://mui.com/material-ui/api/drawer/)
*/
declare const SwipeableDrawer: React.JSXElementConstructor<SwipeableDrawerProps>;
export default SwipeableDrawer;

Event Timeline

c4science · Help