Skip to content
Edit this page

SpeedDial API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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.

ariaLabelRequired

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

Type:

string
children

SpeedDialActions to display when the SpeedDial is open.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
direction

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

Type:

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

Default:

'up'
FabProps

Props applied to the Fab element.

Type:

object

Default:

{}
hidden

If true, the SpeedDial is hidden.

Type:

bool

Default:

false
icon

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

Type:

node
onClose

Callback fired when the component requests to be closed.

Type:

func

Signature:

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

Callback fired when the component requests to be open.

Type:

func

Signature:

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

If true, the component is shown.

Type:

bool
openIcon

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

Type:

node
sx

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

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
TransitionComponent

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

Type:

elementType

Default:

Zoom
transitionDuration

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

Type:

number | { appear?: number, enter?: number, exit?: number }

Default:

{ enter: theme.transitions.duration.enteringScreen, exit: theme.transitions.duration.leavingScreen, }
TransitionProps

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

Type:

object
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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiSpeedDial-rootroot

Styles applied to the root element.

.MuiSpeedDial-fabfab

Styles applied to the Fab component.

.MuiSpeedDial-directionUpdirectionUp

Styles applied to the root element if direction="up"

.MuiSpeedDial-directionDowndirectionDown

Styles applied to the root element if direction="down"

.MuiSpeedDial-directionLeftdirectionLeft

Styles applied to the root element if direction="left"

.MuiSpeedDial-directionRightdirectionRight

Styles applied to the root element if direction="right"

.MuiSpeedDial-actionsactions

Styles applied to the actions (children wrapper) element.

.MuiSpeedDial-actionsClosedactionsClosed

Styles applied to the actions (children wrapper) element if open={false}.

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