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 of the SvgIcon 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 classes 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 | Array<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.
While not explicitly documented above, the props of the SvgIcon component are also available in StepIcon. You can take advantage of this to target nested components.
You can use MuiStepIcon to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component’s slots when specific states are triggered.
| Class name | Rule name | Description |
|---|---|---|
.Mui-active |
- | State class applied to the root element if active={true}. |
.Mui-completed |
- | State class applied to the root element if completed={true}. |
.Mui-error |
- | State class applied to the root element if error={true}. |
.MuiStepIcon-root |
root | Styles applied to the root element. |
.MuiStepIcon-text |
text | Styles applied to the SVG text element. |
You can override the style of the component using one of these customization options:
styleOverrides property in a custom theme.If you did not find the information in this page, consider having a look at the implementation of the component for more detail.