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.

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	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 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:

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