Skip to content

SpeedDial API

API reference docs for the React SpeedDial component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import SpeedDial from '@mui/material/SpeedDial';
// or
import { SpeedDial } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
ariaLabel*string-

The aria-label of the button element. Also used to provide the id for the SpeedDial element and its children.

childrennode-

SpeedDialActions to display when the SpeedDial is open.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

direction'down'
| 'left'
| 'right'
| 'up'		'up'

The direction the actions open relative to the floating action button.

FabPropsobject{}

Props applied to the Fab element.

hiddenboolfalse

If true, the SpeedDial is hidden.

iconnode-

The icon to display in the SpeedDial Fab. The SpeedDialIcon component provides a default Icon with animation.

onClosefunc-

Callback fired when the component requests to be closed.

Signature:function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "toggle", "blur", "mouseLeave", "escapeKeyDown".
onOpenfunc-

Callback fired when the component requests to be open.

Signature:function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "toggle", "focus", "mouseEnter".
openbool-

If true, the component is shown.

openIconnode-

The icon to display in the SpeedDial Fab when the SpeedDial is open.

slotProps{ transition?: func
| object }		{}

The props used for each slot inside.

slots{ transition?: elementType }{}

The components used for each slot inside.

sxArray<func
| object
| bool>
| func
| object		-

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

TransitionComponentelementTypeZoom * @deprecated Use `slots.transition` instead. This prop will be removed in v7. [How to migrate](/material-ui/migration/migrating-from-deprecated-apis/)

The component used for the transition. Follow this guide to learn more about the requirements for this component.

transitionDurationnumber
| { appear?: number, enter?: number, exit?: number }		{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }

The duration for the transition, in milliseconds. You may specify a single timeout for all transitions, or individually with an object.

TransitionPropsobject-

Props applied to the transition element. By default, the element is based on this Transition component.

The ref is forwarded to the root element.

Theme default props

You can use MuiSpeedDial to change the default props of this component with the theme.

Slots

Slot nameClass nameDefault componentDescription
transition{}The component that renders the transition. Follow this guide to learn more about the requirements for this component.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiSpeedDial-actionsactionsStyles applied to the actions (children wrapper) element.
.MuiSpeedDial-actionsClosedactionsClosedStyles applied to the actions (children wrapper) element if open={false}.
.MuiSpeedDial-directionDowndirectionDownStyles applied to the root element if direction="down"
.MuiSpeedDial-directionLeftdirectionLeftStyles applied to the root element if direction="left"
.MuiSpeedDial-directionRightdirectionRightStyles applied to the root element if direction="right"
.MuiSpeedDial-directionUpdirectionUpStyles applied to the root element if direction="up"
.MuiSpeedDial-fabfabStyles applied to the Fab component.
.MuiSpeedDial-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options: