Stepper API

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

Component demos

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

Stepper

Import

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

Props of the native component are also available.

children

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

Type:node

component

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

Type:elementType

orientation

The component orientation.

Type:'horizontal' | 'vertical'

Default:'horizontal'

size

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.

Type:'lg' | 'md' | 'sm' | string

Default:'md'

slotProps

The props used for each slot inside.

Type:{ root?: func | object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

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

Slots

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

root

The component that renders the root.

Class name: .MuiStepper-root

Default component: 'ol'

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiStepper-horizontal

Class name applied to the root element if orientation="horizontal".

Rule name:horizontal

.MuiStepper-sizeLg

Class name applied to the root element if size="lg".

Rule name:sizeLg

.MuiStepper-sizeMd

Class name applied to the root element if size="md".

Rule name:sizeMd

.MuiStepper-sizeSm

Class name applied to the root element if size="sm".

Rule name:sizeSm

.MuiStepper-vertical

Class name applied to the root element if orientation="vertical".

Rule name:vertical

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.