Skip to content

Stepper API

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

Demos

Import

import Stepper from '@mui/material/Stepper';
// or
import { Stepper } 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
activeStepinteger0

Set the active step (zero based index). Set to -1 to disable all the steps.

alternativeLabelboolfalse

If set to 'true' and orientation is horizontal, then the step label will be positioned under the icon.

childrennode-

Two or more <Step /> components.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

componentelementType-

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

connectorelement<StepConnector />

An element to be placed between each step.

nonLinearboolfalse

If set the Stepper will not assist in controlling steps for linear flow.

orientation'horizontal'
| 'vertical'
'horizontal'

The component orientation (layout flow direction).

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 MuiStepper 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
.MuiStepper-alternativeLabelalternativeLabelStyles applied to the root element if alternativeLabel={true}.
.MuiStepper-horizontalhorizontalStyles applied to the root element if orientation="horizontal".
.MuiStepper-nonLinearnonLinearStyles applied to the root element if nonLinear={true}.
.MuiStepper-rootrootStyles applied to the root element.
.MuiStepper-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.