-
-
Notifications
You must be signed in to change notification settings - Fork 32.2k
/
Slide.d.ts
64 lines (62 loc) · 2.04 KB
/
Slide.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
import * as React from 'react';
import { TransitionProps } from '../transitions/transition';
export interface SlideProps extends TransitionProps {
/**
* Perform the enter transition when it first mounts if `in` is also `true`.
* Set this to `false` to disable this behavior.
* @default true
*/
appear?: boolean;
/**
* A single child content element.
*/
children: React.ReactElement<unknown, any>;
/**
* An HTML element, or a function that returns one.
* It's used to set the container the Slide is transitioning from.
*/
container?: null | Element | ((element: Element) => Element);
/**
* Direction the child node will enter from.
* @default 'down'
*/
direction?: 'left' | 'right' | 'up' | 'down';
/**
* The transition timing function.
* You may specify a single easing or a object containing enter and exit values.
* @default {
* enter: theme.transitions.easing.easeOut,
* exit: theme.transitions.easing.sharp,
* }
*/
easing?: TransitionProps['easing'];
/**
* If `true`, the component will transition in.
*/
in?: TransitionProps['in'];
ref?: React.Ref<unknown>;
/**
* The duration for the transition, in milliseconds.
* You may specify a single timeout for all transitions, or individually with an object.
* @default {
* enter: theme.transitions.duration.enteringScreen,
* exit: theme.transitions.duration.leavingScreen,
* }
*/
timeout?: TransitionProps['timeout'];
}
/**
* The Slide transition is used by the [Drawer](https://mui.com/material-ui/react-drawer/) component.
* It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.
*
* Demos:
*
* - [Dialog](https://mui.com/material-ui/react-dialog/)
* - [Transitions](https://mui.com/material-ui/transitions/)
*
* API:
*
* - [Slide API](https://mui.com/material-ui/api/slide/)
* - inherits [Transition API](https://reactcommunity.org/react-transition-group/transition/#Transition-props)
*/
export default function Slide(props: SlideProps): React.JSX.Element;