Step API

API reference docs for the React Step 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 Step from '@mui/joy/Step';
// or
import { Step } from '@mui/joy';

Props of the native component are also available.

Name	Type	Default	Description
active	bool	false	If `true`, the active className is appended. You can customize the active state from the Stepper's `sx` prop.
children	node	-	Used to render icon or text elements inside the Step if `src` is not set. This can be an element, or just a string.
completed	bool	false	If `true`, the completed className is appended. You can customize the active state from the Stepper's `sx` prop.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, the active className is appended. You can customize the active state from the Stepper's `sx` prop.
indicator	node	-	The indicator to display. If provided, a wrapper element will be used.
orientation	'horizontal' \| 'vertical'	'horizontal'	The component orientation.
slotProps	{ indicator?: func \| object, root?: func \| object }	{}	The props used for each slot inside.
slots	{ indicator?: elementType, root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<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.

You can use JoyStep 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 name	Class name	Default component	Description
root	.MuiStep-root	`'li'`	The component that renders the root.
indicator	.MuiStep-indicator	`'div'`	The component that renders the indicator.

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

Class name	Rule name	Description
.Mui-active		Class name applied to the root element if `active` is true.
.Mui-completed		Class name applied to the root element if `completed` is true.
.Mui-disabled		Class name applied to the root element if `disabled` is true.
.MuiStep-horizontal	horizontal	Class name applied to the root element if `orientation="horizontal"`.
.MuiStep-vertical	vertical	Class name applied to the root element if `orientation="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.

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.