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.

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

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 classes

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

.MuiSpeedDial-actions

Styles applied to the actions (children wrapper) element.

Rule name:actions

.MuiSpeedDial-actionsClosed

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

Rule name:actionsClosed

.MuiSpeedDial-directionDown

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

Rule name:directionDown

.MuiSpeedDial-directionLeft

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

Rule name:directionLeft

.MuiSpeedDial-directionRight

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

Rule name:directionRight

.MuiSpeedDial-directionUp

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

Rule name:directionUp

.MuiSpeedDial-fab

Styles applied to the Fab component.

Rule name:fab

.MuiSpeedDial-root

Styles applied to the root element.

Rule name:root


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