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.


For examples and details on the usage of this React component, visit the component demo pages:


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

Component name

The name MuiStepIcon can be used when providing default props or style overrides in the theme.


Props of the native component are also available.

Whether this step is active.
Override or extend the styles applied to the component. See CSS API below for more details.
Mark the step as completed. Is passed to child components.
If true, the step is marked as failed.
The label displayed in the step icon.
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.


Rule nameGlobal classDescription
root.MuiStepIcon-rootStyles applied to the root element.
text.MuiStepIcon-textStyles applied to the SVG text element.
active.Mui-activeState class applied to the root element if active={true}.
completed.Mui-completedState class applied to the root element if completed={true}.
error.Mui-errorState class applied to the root element if error={true}.

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