Skip to content

StepLabel API

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


import StepLabel from '@material-ui/core/StepLabel';
// or
import { StepLabel } from '@material-ui/core';
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.


childrennodeIn most cases will simply be a string containing a title for the label.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
errorboolfalseIf true, the step is marked as failed.
iconnodeOverride the default label of the step icon.
optionalnodeThe optional node to display.
StepIconComponentelementTypeThe component to render in place of the StepIcon.
StepIconPropsobjectProps applied to the StepIcon element.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).


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 Typography component that wraps `children`.
active.MuiStepLabel-activePseudo-class applied to the `Typography` component if active={true}.
completed.MuiStepLabel-completedPseudo-class applied to the `Typography` component if completed={true}.
error.Mui-errorPseudo-class applied to the root element and `Typography` component if error={true}.
disabled.Mui-disabledPseudo-class applied to the root element and `Typography` component if disabled={true}.
iconContainer.MuiStepLabel-iconContainerStyles applied to the `icon` container element.
alternativeLabel.MuiStepLabel-alternativeLabelPseudo-class applied to the root and icon container and `Typography` if alternativeLabel={true}.
labelContainer.MuiStepLabel-labelContainerStyles applied to the container element which wraps `Typography` and `optional`.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.