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.

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.

NameTypeDefaultDescription
activeboolfalse

Whether this step is active.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

completedboolfalse

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

errorboolfalse

If true, the step is marked as failed.

iconnode-

The label displayed in the step icon.

sxArray<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.

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.

Class nameRule nameDescription
.Mui-activeState class applied to the root element if active={true}.
.Mui-completedState class applied to the root element if completed={true}.
.Mui-errorState class applied to the root element if error={true}.
.MuiStepIcon-rootrootStyles applied to the root element.
.MuiStepIcon-texttextStyles applied to the SVG text element.

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