Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

In most cases will simply be a string containing a title for the label.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
componentsProps

The props used for each slot inside.

Type:

{ label?: object }

Default:

{}
error

If true, the step is marked as failed.

Type:

bool

Default:

false
icon

Override the default label of the step icon.

Type:

node
optional

The optional node to display.

Type:

node
slotProps

The props used for each slot inside.

Type:

{ label?: object }

Default:

{}
StepIconComponent

The component to render in place of the StepIcon.

Type:

elementType
StepIconProps

Props applied to the StepIcon element.

Type:

object
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
The ref is forwarded to the root element.

Theme default props

You can use MuiStepLabel to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiStepLabel-rootroot

Styles applied to the root element.

.MuiStepLabel-horizontalhorizontal

Styles applied to the root element if orientation="horizontal".

.MuiStepLabel-verticalvertical

Styles applied to the root element if orientation="vertical".

.MuiStepLabel-labellabel

Styles applied to the label element that wraps children.

.Mui-activeactiveSTATE

State class applied to the label element if active={true}.

.Mui-completedcompletedSTATE

State class applied to the label element if completed={true}.

.Mui-errorerrorSTATE

State class applied to the root and label elements if error={true}.

.Mui-disableddisabledSTATE

State class applied to the root and label elements if disabled={true}.

.MuiStepLabel-iconContainericonContainer

Styles applied to the icon container element.

.MuiStepLabel-alternativeLabelalternativeLabel

State class applied to the root and icon container and label if alternativeLabel={true}.

.MuiStepLabel-labelContainerlabelContainer

Styles applied to the container element which wraps label and optional.

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