Skip to content

Step API

The API documentation of the Step React component. Learn more about the props and the CSS customization points.

Import

import Step from '@material-ui/core/Step';
// or
import { Step } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiStep name can be used for providing default props or style overrides at the theme level.

Props

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 API below for more details.
completed bool Mark the step as completed. Is passed to child components.
disabled bool 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 number 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.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
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 thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos