StepIcon API

API documentation for the React StepIcon component. Learn about the available props, and the CSS API.

Import

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

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

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

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 using one of these customization options:

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