Skip to content
Edit this page

Stepper API

API reference docs for the React Stepper 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 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.

activeStep

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

Type:

integer

Default:

0
alternativeLabel

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

Type:

bool

Default:

false
children

Two or more <Step /> components.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
component

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

Type:

elementType
connector

An element to be placed between each step.

Type:

element

Default:

<StepConnector />
nonLinear

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

Type:

bool

Default:

false
orientation

The component orientation (layout flow direction).

Type:

'horizontal' | 'vertical'

Default:

'horizontal'
sx

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 MuiStepper 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.


.MuiStepper-rootroot

Styles applied to the root element.

.MuiStepper-horizontalhorizontal

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

.MuiStepper-verticalvertical

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

.MuiStepper-alternativeLabelalternativeLabel

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

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