跳转到内容

StepIcon API

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

Import

import StepIcon from '@mui/material/StepIcon';
// 或
import { StepIcon } from '@mui/material';
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.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
activeboolfalse
Whether this step is active.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
completedboolfalse
Mark the step as completed. Is passed to child components.
errorboolfalse
Mark the step as failed.
iconnode
The label displayed in the step icon.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
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:

Demos