Skip to content

StepLabel API

API reference docs for the React StepLabel 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 StepLabel from '@mui/material/StepLabel';
// or
import { StepLabel } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
In most cases will simply be a string containing a title for the label.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentsProps{ label?: object }{}
The props used for each slot inside.
errorboolfalse
If true, the step is marked as failed.
iconnode
Override the default label of the step icon.
optionalnode
The optional node to display.
slotProps{ label?: object }{}
The props used for each slot inside.
StepIconComponentelementType
The component to render in place of the StepIcon.
StepIconPropsobject
Props applied to the StepIcon element.
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.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiStepLabel-rootStyles applied to the root element.
horizontal.MuiStepLabel-horizontalStyles applied to the root element if orientation="horizontal".
vertical.MuiStepLabel-verticalStyles applied to the root element if orientation="vertical".
label.MuiStepLabel-labelStyles applied to the label element that wraps `children`.
active.Mui-activeState class applied to the label element if active={true}.
completed.Mui-completedState class applied to the label element if completed={true}.
error.Mui-errorState class applied to the root and label elements if error={true}.
disabled.Mui-disabledState class applied to the root and label elements if disabled={true}.
iconContainer.MuiStepLabel-iconContainerStyles applied to the `icon` container element.
alternativeLabel.MuiStepLabel-alternativeLabelState class applied to the root and icon container and label if alternativeLabel={true}.
labelContainer.MuiStepLabel-labelContainerStyles applied to the container element which wraps label and `optional`.

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