SpeedDialAction API
API documentation for the React SpeedDialAction component. Learn about the available props, and the CSS API.
Import
import SpeedDialAction from '@material-ui/core/SpeedDialAction';
// or
import { SpeedDialAction } from '@material-ui/core';Component name
The nameMuiSpeedDialAction can be used when providing default props or style overrides in the theme.Props
| Name | Type | Default | Description |
|---|---|---|---|
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| delay | number | 0 | Adds a transition delay, to allow a series of SpeedDialActions to be animated. |
| FabProps | object | {} | Props applied to the Fab component. |
| icon | node | The Icon to display in the SpeedDial Fab. | |
| id | string | This prop is used to help implement the accessibility logic. If you don't provide this prop. It falls back to a randomly generated id. | |
| open | bool | false | If true, the tooltip is shown. |
| TooltipClasses | object | classes prop applied to the Tooltip element. | |
| tooltipOpen | bool | false | Make the tooltip always visible when the SpeedDial is open. |
| tooltipPlacement | 'bottom-end' | 'bottom-start' | 'bottom' | 'left-end' | 'left-start' | 'left' | 'right-end' | 'right-start' | 'right' | 'top-end' | 'top-start' | 'top' | 'left' | Placement of the tooltip. |
| tooltipTitle | node | Label to display in the tooltip. |
The
ref is forwarded to the root element.Any other props supplied will be provided to the root element (Tooltip).
Inheritance
While not explicitly documented above, the props of the Tooltip component are also available on SpeedDialAction. You can take advantage of this to target nested components.CSS
| Rule name | Global class | Description |
|---|---|---|
| fab | .MuiSpeedDialAction-fab | Styles applied to the Fab component. |
| fabClosed | .MuiSpeedDialAction-fabClosed | Styles applied to the Fab component if open={false}. |
| staticTooltip | .MuiSpeedDialAction-staticTooltip | Styles applied to the root element if tooltipOpen={true}. |
| staticTooltipClosed | .MuiSpeedDialAction-staticTooltipClosed | Styles applied to the root element if tooltipOpen={true} and open={false}. |
| staticTooltipLabel | .MuiSpeedDialAction-staticTooltipLabel | Styles applied to the static tooltip label if tooltipOpen={true}. |
| tooltipPlacementLeft | .MuiSpeedDialAction-tooltipPlacementLeft | Styles applied to the root if tooltipOpen={true} and tooltipPlacement="left". |
| tooltipPlacementRight | .MuiSpeedDialAction-tooltipPlacementRight | Styles applied to the root if tooltipOpen={true} and tooltipPlacement="right". |
You can override the style of the component using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.