UNPKG

918 BTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '@material-ui/core';
3
4export interface SpeedDialIconProps
5 extends StandardProps<React.HTMLAttributes<HTMLSpanElement>, SpeedDialIconClassKey, 'children'> {
6 /**
7 * The icon to display in the SpeedDial Floating Action Button.
8 */
9 icon?: React.ReactNode;
10 /**
11 * The icon to display in the SpeedDial Floating Action Button when the SpeedDial is open.
12 */
13 openIcon?: React.ReactNode;
14 /**
15 * @ignore
16 * If `true`, the SpeedDial is open.
17 */
18 open?: boolean;
19}
20
21export type SpeedDialIconClassKey =
22 | 'root'
23 | 'icon'
24 | 'iconOpen'
25 | 'iconWithOpenIconOpen'
26 | 'openIcon'
27 | 'openIconOpen';
28
29/**
30 *
31 * Demos:
32 *
33 * - [Speed Dial](https://mui.com/components/speed-dial/)
34 *
35 * API:
36 *
37 * - [SpeedDialIcon API](https://mui.com/api/speed-dial-icon/)
38 */
39export default function SpeedDialIcon(props: SpeedDialIconProps): JSX.Element;