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.

Component demos

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.

See CSS API below for more details.

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.

See the `sx` page for more details.

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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.Mui-activeSTATE

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

.Mui-completedSTATE

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

.Mui-disabledSTATE

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

.Mui-errorSTATE

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

.MuiStepLabel-alternativeLabel

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

Rule name:alternativeLabel

.MuiStepLabel-horizontal

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

Rule name:horizontal

.MuiStepLabel-iconContainer

Styles applied to the icon container element.

Rule name:iconContainer

.MuiStepLabel-label

Styles applied to the label element that wraps children.

Rule name:label

.MuiStepLabel-labelContainer

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

Rule name:labelContainer

.MuiStepLabel-root

Styles applied to the root element.

Rule name:root

.MuiStepLabel-vertical

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

Rule name:vertical


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