StepIcon API
The API documentation of the StepIcon React component. Learn more about the properties and the CSS customization points.
import StepIcon from '@material-ui/core/StepIcon';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 icon displayed by the step label. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (native element).
CSS
You can override all the class names injected by Material-UI thanks to the classes property.
This property accepts the following keys:
| Name | Description |
|---|---|
| root | Styles applied to the root element. |
| text | Styles applied to the SVG text element. |
| active | Styles applied to the root element if active={true}. |
| completed | Styles applied to the root element if completed={true}. |
| error | Styles applied to the root element if error={true}. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiStepIcon.
Notes
The component is fully StrictMode compatible.