Skip to content
Edit this page

Step API

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

Demos

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

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.

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
sx

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

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiStep-rootroot

Styles applied to the root element.

.MuiStep-horizontalhorizontal

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

.MuiStep-verticalvertical

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

.MuiStep-alternativeLabelalternativeLabel

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

.Mui-completedcompletedSTATE

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

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