Skip to content
Edit this page

StepIcon API

API reference docs for the React StepIcon 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 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.

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.

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

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

.MuiStepIcon-rootroot

Styles applied to the root element.

.MuiStepIcon-texttext

Styles applied to the SVG text element.

.Mui-activeactiveSTATE

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

.Mui-completedcompletedSTATE

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

.Mui-errorerrorSTATE

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

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