Step API

API reference docs for the React Step component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Stepper

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.

active

Sets the step as active. Is passed to child components.

Type:bool

children

Should be Step sub-components such as StepLabel, StepContent.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

completed

Mark the step as completed. Is passed to child components.

Type:bool

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

disabled

If true, the step is disabled, will also disable the button if StepButton is a child of Step. Is passed to child components.

Type:bool

expanded

Expand the step.

Type:bool

Default:false

index

The position of the step. The prop defaults to the value inherited from the parent Stepper component.

Type:integer

last

If true, the Step is displayed as rendered last. The prop defaults to the value inherited from the parent Stepper component.

Type:bool

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

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.

.Mui-completedSTATE

State class applied to the root element if completed={true}.

.MuiStep-alternativeLabel

Styles applied to the root element if alternativeLabel={true}.

Rule name:alternativeLabel

.MuiStep-horizontal

Styles applied to the root element if orientation="horizontal".

Rule name:horizontal

.MuiStep-root

Styles applied to the root element.

Rule name:root

.MuiStep-vertical

Styles applied to the root element if orientation="vertical".

Rule name:vertical

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.