UNPKG

1.34 kBTypeScriptView Raw
1import * as React from 'react';
2import { Omit } from '..';
3import { TransitionProps } from '../transitions/transition';
4
5export interface FadeProps extends Omit<TransitionProps, 'children'> {
6 /**
7 * A single child content element.
8 */
9 children?: React.ReactElement<any, any>;
10 /**
11 * Enable this prop if you encounter 'Function components cannot be given refs',
12 * use `unstable_createStrictModeTheme`,
13 * and can't forward the ref in the child component.
14 */
15 disableStrictModeCompat?: boolean;
16 /**
17 * If `true`, the component will transition in.
18 */
19 in?: boolean;
20 ref?: React.Ref<unknown>;
21 /**
22 * The duration for the transition, in milliseconds.
23 * You may specify a single timeout for all transitions, or individually with an object.
24 */
25 timeout?: TransitionProps['timeout'];
26}
27
28/**
29 * The Fade transition is used by the [Modal](https://material-ui.com/components/modal/) component.
30 * It uses [react-transition-group](https://github.com/reactjs/react-transition-group) internally.
31 * Demos:
32 *
33 * - [Transitions](https://material-ui.com/components/transitions/)
34 *
35 * API:
36 *
37 * - [Fade API](https://material-ui.com/api/fade/)
38 * - inherits [Transition API](https://reactcommunity.org/react-transition-group/transition#Transition-props)
39 */
40export default function Fade(props: FadeProps): JSX.Element;