跳转到内容

SpeedDial API

API documentation for the React SpeedDial component. Learn about the available props, and the CSS API.

Import

import SpeedDial from '@mui/material/SpeedDial';
// 或
import { SpeedDial } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiSpeedDial can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
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 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".
openboolfalse
Control the popup` open state.
openIconnode
The icon to display in the SpeedDial Fab when the SpeedDial is open.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
TransitionComponentelementTypeZoom
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: duration.enteringScreen, exit: 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.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiSpeedDial-rootStyles applied to the root element.
fab.MuiSpeedDial-fabStyles applied to the Fab component.
directionUp.MuiSpeedDial-directionUpStyles applied to the root element if direction="up"
directionDown.MuiSpeedDial-directionDownStyles applied to the root element if direction="down"
directionLeft.MuiSpeedDial-directionLeftStyles applied to the root element if direction="left"
directionRight.MuiSpeedDial-directionRightStyles applied to the root element if direction="right"
actions.MuiSpeedDial-actionsStyles applied to the actions (`children` wrapper) element.
actionsClosed.MuiSpeedDial-actionsClosedStyles applied to the actions (`children` wrapper) element if open={false}.

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

Demos