UNPKG

1.49 kBTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '@material-ui/core';
3import { FabProps } from '@material-ui/core/Fab';
4import { TooltipProps } from '@material-ui/core/Tooltip';
5
6export interface SpeedDialActionProps
7 extends StandardProps<Partial<TooltipProps>, SpeedDialActionClassKey, 'children'> {
8 /**
9 * Props applied to the [`Fab`](/api/fab/) component.
10 */
11 FabProps?: Partial<FabProps>;
12 /**
13 * Adds a transition delay, to allow a series of SpeedDialActions to be animated.
14 */
15 delay?: number;
16 /**
17 * The Icon to display in the SpeedDial Fab.
18 */
19 icon?: React.ReactNode;
20 /**
21 * `classes` prop applied to the [`Tooltip`](/api/tooltip/) element.
22 */
23 TooltipClasses?: TooltipProps['classes'];
24 /**
25 * Placement of the tooltip.
26 */
27 tooltipPlacement?: TooltipProps['placement'];
28 /**
29 * Label to display in the tooltip.
30 */
31 tooltipTitle?: React.ReactNode;
32 /**
33 * Make the tooltip always visible when the SpeedDial is open.
34 */
35 tooltipOpen?: boolean;
36}
37
38export type SpeedDialActionClassKey =
39 | 'fab'
40 | 'fabClosed'
41 | 'staticTooltip'
42 | 'staticTooltipClosed'
43 | 'staticTooltipLabel'
44 | 'tooltipPlacementLeft';
45
46/**
47 *
48 * Demos:
49 *
50 * - [Speed Dial](https://mui.com/components/speed-dial/)
51 *
52 * API:
53 *
54 * - [SpeedDialAction API](https://mui.com/api/speed-dial-action/)
55 * - inherits [Tooltip API](https://mui.com/api/tooltip/)
56 */
57export default function SpeedDialAction(props: SpeedDialActionProps): JSX.Element;