UNPKG

1.83 kBTypeScriptView Raw
1import * as React from 'react';
2import { SxProps } from '@mui/system';
3import { Theme } from '../styles';
4import { InternalStandardProps as StandardProps } from '..';
5import { FabProps } from '../Fab';
6import { TooltipProps } from '../Tooltip';
7import { SpeedDialActionClasses } from './speedDialActionClasses';
8
9export interface SpeedDialActionProps extends StandardProps<Partial<TooltipProps>, 'children'> {
10 /**
11 * Override or extend the styles applied to the component.
12 */
13 classes?: Partial<SpeedDialActionClasses>;
14 /**
15 * Props applied to the [`Fab`](https://mui.com/material-ui/api/fab/) component.
16 * @default {}
17 */
18 FabProps?: Partial<FabProps>;
19 /**
20 * Adds a transition delay, to allow a series of SpeedDialActions to be animated.
21 * @default 0
22 */
23 delay?: number;
24 /**
25 * The icon to display in the SpeedDial Fab.
26 */
27 icon?: React.ReactNode;
28 /**
29 * The system prop that allows defining system overrides as well as additional CSS styles.
30 */
31 sx?: SxProps<Theme>;
32 /**
33 * `classes` prop applied to the [`Tooltip`](https://mui.com/material-ui/api/tooltip/) element.
34 */
35 TooltipClasses?: TooltipProps['classes'];
36 /**
37 * Placement of the tooltip.
38 * @default 'left'
39 */
40 tooltipPlacement?: TooltipProps['placement'];
41 /**
42 * Label to display in the tooltip.
43 */
44 tooltipTitle?: React.ReactNode;
45 /**
46 * Make the tooltip always visible when the SpeedDial is open.
47 * @default false
48 */
49 tooltipOpen?: boolean;
50}
51
52/**
53 *
54 * Demos:
55 *
56 * - [Speed Dial](https://mui.com/material-ui/react-speed-dial/)
57 *
58 * API:
59 *
60 * - [SpeedDialAction API](https://mui.com/material-ui/api/speed-dial-action/)
61 * - inherits [Tooltip API](https://mui.com/material-ui/api/tooltip/)
62 */
63export default function SpeedDialAction(props: SpeedDialActionProps): React.JSX.Element;