UNPKG

1.69 kBTypeScriptView Raw
1import * as React from 'react';
2import { TransitionProps } from '../transitions/transition';
3
4export interface GrowProps extends Omit<TransitionProps, 'timeout'> {
5 /**
6 * Perform the enter transition when it first mounts if `in` is also `true`.
7 * Set this to `false` to disable this behavior.
8 * @default true
9 */
10 appear?: boolean;
11 /**
12 * A single child content element.
13 */
14 children: React.ReactElement<unknown, any>;
15 /**
16 * The transition timing function.
17 * You may specify a single easing or a object containing enter and exit values.
18 */
19 easing?: TransitionProps['easing'];
20 /**
21 * If `true`, the component will transition in.
22 */
23 in?: boolean;
24 ref?: React.Ref<unknown>;
25 /**
26 * The duration for the transition, in milliseconds.
27 * You may specify a single timeout for all transitions, or individually with an object.
28 *
29 * Set to 'auto' to automatically calculate transition time based on height.
30 * @default 'auto'
31 */
32 timeout?: TransitionProps['timeout'] | 'auto';
33}
34
35/**
36 * The Grow transition is used by the [Tooltip](https://mui.com/material-ui/react-tooltip/) and
37 * [Popover](https://mui.com/material-ui/react-popover/) components.
38 * It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.
39 *
40 * Demos:
41 *
42 * - [Popover](https://mui.com/material-ui/react-popover/)
43 * - [Transitions](https://mui.com/material-ui/transitions/)
44 *
45 * API:
46 *
47 * - [Grow API](https://mui.com/material-ui/api/grow/)
48 * - inherits [Transition API](https://reactcommunity.org/react-transition-group/transition/#Transition-props)
49 */
50export default function Grow(props: GrowProps): React.JSX.Element;