SpeedDialAction.d.ts
5.02 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
import * as React from 'react';
import { SxProps } from '@mui/system';
import { Theme } from "../styles/index.js";
import { InternalStandardProps as StandardProps } from "../internal/index.js";
import { FabProps } from "../Fab/index.js";
import { TooltipProps } from "../Tooltip/index.js";
import { SpeedDialActionClasses } from "./speedDialActionClasses.js";
import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
export interface SpeedDialActionSlots {
/**
* The component that renders the fab.
* @default Fab
*/
fab?: React.ElementType;
/**
* The component that renders the tooltip.
* @default Tooltip
*/
tooltip?: React.ElementType;
/**
* The component that renders the static tooltip.
* @default 'span'
*/
staticTooltip?: React.ElementType;
/**
* The component that renders the static tooltip label.
* @default 'span'
*/
staticTooltipLabel?: React.ElementType;
}
export interface SpeedDialActionFabSlotPropsOverrides {}
export interface SpeedDialActionTooltipSlotPropsOverrides {}
export interface SpeedDialActionStaticTooltipSlotPropsOverrides {}
export interface SpeedDialActionStaticTooltipLabelSlotPropsOverrides {}
export type SpeedDialActionSlotsAndSlotProps = CreateSlotsAndSlotProps<SpeedDialActionSlots, {
/**
* Props forwarded to the fab slot.
* By default, the available props are based on the [Fab](https://mui.com/material-ui/api/fab/#props) component.
*/
fab: SlotProps<React.ElementType<FabProps>, SpeedDialActionFabSlotPropsOverrides, SpeedDialActionOwnerState>;
/**
* Props forwarded to the tooltip slot.
* By default, the available props are based on the [Tooltip](https://mui.com/material-ui/api/tooltip/#props) component.
*/
tooltip: SlotProps<React.ElementType<TooltipProps>, SpeedDialActionTooltipSlotPropsOverrides, SpeedDialActionOwnerState>;
/**
* Props forwarded to the static tooltip slot.
* By default, the available props are based on a span element.
*/
staticTooltip: SlotProps<'span', SpeedDialActionStaticTooltipSlotPropsOverrides, SpeedDialActionOwnerState>;
/**
* Props forwarded to the static tooltip label slot.
* By default, the available props are based on a span element.
*/
staticTooltipLabel: SlotProps<'span', SpeedDialActionStaticTooltipLabelSlotPropsOverrides, SpeedDialActionOwnerState>;
}>;
export interface SpeedDialActionProps extends Omit<StandardProps<Partial<TooltipProps>, 'children'>, 'slotProps' | 'slots'>, SpeedDialActionSlotsAndSlotProps {
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<SpeedDialActionClasses>;
/**
* Props applied to the [`Fab`](https://mui.com/material-ui/api/fab/) component.
* @default {}
* @deprecated Use `slotProps.fab` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
*/
FabProps?: Partial<FabProps>;
/**
* Adds a transition delay, to allow a series of SpeedDialActions to be animated.
* @default 0
*/
delay?: number;
/**
* The icon to display in the SpeedDial Fab.
*/
icon?: React.ReactNode;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme>;
/**
* `classes` prop applied to the [`Tooltip`](https://mui.com/material-ui/api/tooltip/) element.
* @deprecated Use `slotProps.tooltip.classes` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
*/
TooltipClasses?: TooltipProps['classes'];
/**
* Placement of the tooltip.
* @default 'left'
* @deprecated Use `slotProps.tooltip.placement` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
*/
tooltipPlacement?: TooltipProps['placement'];
/**
* Label to display in the tooltip.
* @deprecated Use `slotProps.tooltip.title` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
*/
tooltipTitle?: React.ReactNode;
/**
* Make the tooltip always visible when the SpeedDial is open.
* @default false
* @deprecated Use `slotProps.tooltip.open` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
*/
tooltipOpen?: boolean;
}
/**
*
* Demos:
*
* - [Speed Dial](https://mui.com/material-ui/react-speed-dial/)
*
* API:
*
* - [SpeedDialAction API](https://mui.com/material-ui/api/speed-dial-action/)
* - inherits [Tooltip API](https://mui.com/material-ui/api/tooltip/)
*/
export default function SpeedDialAction(props: SpeedDialActionProps): React.JSX.Element;
export interface SpeedDialActionOwnerState extends Omit<SpeedDialActionProps, 'slots' | 'slotProps'> {}