Skip to content
Edit this page

Step API

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

Import

import Step from '@material-ui/core/Step';
// or
import { Step } from '@material-ui/core';
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

NameTypeDefaultDescription
activeboolfalseSets the step as active. Is passed to child components.
childrennodeShould be Step sub-components such as StepLabel, StepContent.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
completedboolfalseMark the step as completed. Is passed to child components.
disabledboolfalseIf true, the step is disabled, will also disable the button if StepButton is a child of Step. Is passed to child components.
expandedboolfalseExpand the step.
indexintegerThe position of the step. The prop defaults to the value inherited from the parent Stepper component.
lastboolfalseIf true, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component.
sxobjectThe 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.
Any other props supplied will be provided to the root element (native 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.MuiStep-completedPseudo-class applied to the root element if completed={true}.

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

Demos