StepIcon API

The API documentation of the StepIcon React component. Learn more about the props and the CSS customization points.

Import

import StepIcon from '@material-ui/core/StepIcon';
// or
import { StepIcon } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiStepIcon name can be used for providing default props or style overrides at the theme level.

Props

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	Mark the step as failed.
icon	node		The label displayed in the step icon.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

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	.MuiStepIcon-active	Pseudo-class applied to the root element if active={true}.
completed	.MuiStepIcon-completed	Pseudo-class applied to the root element if completed={true}.
error	.Mui-error	Pseudo-class applied to the root element if error={true}.

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Steppers