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.



import Stepper from '@mui/joy/Stepper';
// or
import { Stepper } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.


Props of the native component are also available.


Used to render icon or text elements inside the Stepper if src is not set. This can be an element, or just a string.


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

| 'vertical'

The component orientation.

| 'md'
| 'sm'
| string

The size of the component. It accepts theme values between 'sm' and 'lg'.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ root?: func
| object }

The props used for each slot inside.

slots{ root?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

| 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 JoyStepper to change the default props of this component with the theme.


To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiStepper-root'ol'The component that renders the root.

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-horizontalhorizontalClass name applied to the root element if orientation="horizontal".
.MuiStepper-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiStepper-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiStepper-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiStepper-verticalverticalClass name applied to the root element if orientation="vertical".

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