Skip to content

Stepper API

API documentation for the React Stepper component. Learn about the available props, and the CSS API.

Import

import Stepper from '@material-ui/core/Stepper';
// or
import { Stepper } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiStepper can be used when providing default props or style overrides in the theme.

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

CSS

Rule nameGlobal classDescription
root.MuiStepper-rootStyles applied to the root element.
horizontal.MuiStepper-horizontalStyles applied to the root element if orientation="horizontal".
vertical.MuiStepper-verticalStyles applied to the root element if orientation="vertical".
alternativeLabel.MuiStepper-alternativeLabelStyles applied to the root element if alternativeLabel={true}.

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

Demos