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

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
activebool-

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 classes API below for more details.

completedbool-

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.

disabledbool-

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.

lastbool-

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.

Theme default props

You can use MuiStep to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.Mui-completedState class applied to the root element if completed={true}.
.MuiStep-alternativeLabelalternativeLabelStyles applied to the root element if alternativeLabel={true}.
.MuiStep-horizontalhorizontalStyles applied to the root element if orientation="horizontal".
.MuiStep-rootrootStyles applied to the root element.
.MuiStep-verticalverticalStyles applied to the root element if orientation="vertical".

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

Source code

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