StepLabel API

The API documentation of the StepLabel React component. Learn more about the props and the CSS customization points.

Import

import StepLabel from '@material-ui/core/StepLabel';
// or
import { StepLabel } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiStepLabel name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
children	node		In most cases will simply be a string containing a title for the label.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
disabled	bool	false	Mark the step as disabled, will also disable the button if StepLabelButton is a child of StepLabel. Is passed to child components.
error	bool	false	Mark the step as failed.
icon	node		Override the default label of the step icon.
optional	node		The optional node to display.
StepIconComponent	elementType		The component to render in place of the StepIcon.
StepIconProps	object		Props 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).

CSS

Rule name	Global class	Description
root	.MuiStepLabel-root	Styles applied to the root element.
horizontal	.MuiStepLabel-horizontal	Styles applied to the root element if orientation="horizontal".
vertical	.MuiStepLabel-vertical	Styles applied to the root element if orientation="vertical".
label	.MuiStepLabel-label	Styles applied to the Typography component which wraps children.
active	.MuiStepLabel-active	Pseudo-class applied to the Typography component if active={true}.
completed	.MuiStepLabel-completed	Pseudo-class applied to the Typography component if completed={true}.
error	.Mui-error	Pseudo-class applied to the root element and Typography component if error={true}.
disabled	.Mui-disabled	Pseudo-class applied to the root element and Typography component if disabled={true}.
iconContainer	.MuiStepLabel-iconContainer	Styles applied to the icon container element.
alternativeLabel	.MuiStepLabel-alternativeLabel	Pseudo-class applied to the root and icon container and Typography if alternativeLabel={true}.
labelContainer	.MuiStepLabel-labelContainer	Styles applied to the container element which wraps Typography and optional.

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Steppers