Skip to content

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

import Step from '@mui/material/Step';
// or
import { Step } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
activeboolfalse
Sets the step as active. Is passed to child components.
childrennode
Should be Step sub-components such as StepLabel, StepContent.
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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalse
If true, the step is disabled, will also disable the button if StepButton is a child of Step. Is passed to child components.
expandedboolfalse
Expand the step.
indexinteger
The position of the step. The prop defaults to the value inherited from the parent Stepper component.
lastboolfalse
If true, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component.
sxArray<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.

CSS

Rule nameGlobal classDescription
root.MuiStep-rootStyles applied to the root element.
horizontal.MuiStep-horizontalStyles applied to the root element if orientation="horizontal".
vertical.MuiStep-verticalStyles applied to the root element if orientation="vertical".
alternativeLabel.MuiStep-alternativeLabelStyles applied to the root element if alternativeLabel={true}.
completed.Mui-completedState class applied to the root element if completed={true}.

You can override the style of the component using one of these customization options: