Step API

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

Import

import Step from '@mui/material/Step';
// 或
import { Step } from '@mui/material';

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

Props of the 原生（Native） component are also available.

名称	类型	默认值	描述
active	bool	false	Sets the step as active. Is passed to child components.
children	node		Should be `Step` sub-components such as `StepLabel`, `StepContent`.
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.
disabled	bool	false	Mark the step as disabled, will also disable the button if `StepButton` is a child of `Step`. Is passed to child components.
expanded	bool	false	Expand the step.
index	integer		The position of the step. The prop defaults to the value inherited from the parent Stepper component.
last	bool	false	If `true`, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component.
sx	func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

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

Rule name	Global class	描述
root	.MuiStep-root	Styles applied to the root element.
horizontal	.MuiStep-horizontal	Styles applied to the root element if `orientation="horizontal"`.
vertical	.MuiStep-vertical	Styles applied to the root element if `orientation="vertical"`.
alternativeLabel	.MuiStep-alternativeLabel	Styles applied to the root element if `alternativeLabel={true}`.
completed	.MuiStep-completed	Pseudo-class applied to the root element if `completed={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.