Skip to content

StepIcon API

API reference docs for the React StepIcon component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

Import

import StepIcon from '@mui/material/StepIcon';
// or
import { StepIcon } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

active

Whether this step is active.

Type:bool

Default:false

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

completed

Mark the step as completed. Is passed to child components.

Type:bool

Default:false

error

If true, the step is marked as failed.

Type:bool

Default:false

icon

The label displayed in the step icon.

Type:node

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 MuiStepIcon 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 root element if active={true}.

.Mui-completedSTATE

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

.Mui-errorSTATE

State class applied to the root element if error={true}.

.MuiStepIcon-root

Styles applied to the root element.

Rule name:root

.MuiStepIcon-text

Styles applied to the SVG text element.

Rule name:text


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