Step API

API reference docs for the React Step component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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

Props of the native component are also available.

Name	Type	Default	Description
active	bool	-	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 classes API below for more details.
completed	bool	-	Mark the step as completed. Is passed to child components.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	-	If `true`, the step is 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	-	If `true`, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component.
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.

You can use MuiStep 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-completed		State class applied to the root element if `completed={true}`.
.MuiStep-alternativeLabel	alternativeLabel	Styles applied to the root element if `alternativeLabel={true}`.
.MuiStep-horizontal	horizontal	Styles applied to the root element if `orientation="horizontal"`.
.MuiStep-root	root	Styles applied to the root element.
.MuiStep-vertical	vertical	Styles applied to the root element if `orientation="vertical"`.

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.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.