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 StepIcon from '@mui/material/StepIcon';
// or
import { StepIcon } from '@mui/material';

Props of the native component are also available.

Name	Type	Default	Description
active	bool	false	Whether this step is active.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
completed	bool	false	Mark the step as completed. Is passed to child components.
error	bool	false	If `true`, the step is marked as failed.
icon	node		The label displayed in the step icon.
sx	Array<func \| 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.

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

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

Rule name	Global class	Description
root	.MuiStepIcon-root	Styles applied to the root element.
text	.MuiStepIcon-text	Styles applied to the SVG text element.
active STATE	.Mui-active	State class applied to the root element if `active={true}`.
completed STATE	.Mui-completed	State class applied to the root element if `completed={true}`.
error STATE	.Mui-error	State class applied to the root element if `error={true}`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.