Skip to content

Step API

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

import Step from '@material-ui/core/Step';

Props

Name Type Default Description
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.

The ref is forwarded to the root element.

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

CSS

You can override all the class names injected by Material-UI thanks to the classes prop. This prop accepts the following keys:

Name Description
root Styles applied to the root element.
horizontal Styles applied to the root element if orientation="horizontal".
vertical Styles applied to the root element if orientation="vertical".
alternativeLabel Styles applied to the root element if alternativeLabel={true}.
completed Pseudo-class applied to the root element if completed={true}.

Have a look at the overriding styles with classes section and the implementation of the component for more detail.

If using the overrides key of the theme, you need to use the following style sheet name: MuiStep.

Notes

The component is fully StrictMode compatible.

Demos