Skip to content

StepIcon API

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


import StepIcon from '@material-ui/core/StepIcon';
// or
import { StepIcon } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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


activeboolfalseWhether this step is active.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
completedboolfalseMark the step as completed. Is passed to child components.
errorboolfalseIf true, the step is marked as failed.
iconnodeThe 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 nameGlobal classDescription
root.MuiStepIcon-rootStyles applied to the root element.
text.MuiStepIcon-textStyles applied to the SVG text element.
active.MuiStepIcon-activePseudo-class applied to the root element if active={true}.
completed.MuiStepIcon-completedPseudo-class applied to the root element if completed={true}.
error.Mui-errorPseudo-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.