Step API - Joy UI

Step API - Joy UISkip to contentSkip to content🚀 Influence MUI's 2026 roadmap! Take our latest Developer SurveySearch…

Joy UIv5.0.0-beta.49Getting startedComponentsAPIsAccordionAccordionDetailsAccordionGroupAccordionSummaryAlertAspectRatioAutocompleteAutocompleteListboxAutocompleteOptionAvatarAvatarGroupBadgeBoxBreadcrumbsButtonButtonGroupCardCardActionsCardContentCardCoverCardOverflowCheckboxChipChipDeleteCircularProgressCssBaselineDialogActionsDialogContentDialogTitleDividerDrawerFormControlFormHelperTextFormLabelGridIconButtonInputLinearProgressLinkListListDividerListItemListItemButtonListItemContentListItemDecoratorListSubheaderMenuMenuButtonMenuItemMenuListModalModalCloseModalDialogModalOverflowOptionRadioRadioGroupScopedCssBaselineSelectSheetSkeletonSliderSnackbarStackStepStepButtonStepIndicatorStepperSvgIconSwitchTabTableTabListTabPanelTabsTextareaToggleButtonGroupTooltipTypographyCustomizationIntegrationsMigrationStep 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:

StepperImport

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

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

PropsView:table

Props of the native component are also available.

NameTypeDefaultDescriptionactiveboolfalse

If true, the active className is appended. You can customize the active state from the Stepper's sx prop.

childrennode-

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

completedboolfalse

If true, the completed className is appended. You can customize the active state from the Stepper's sx prop.

componentelementType-

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

disabledboolfalse

If true, the active className is appended. You can customize the active state from the Stepper's sx prop.

indicatornode-

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.

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

SlotsView:table

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

Slot nameClass nameDefault componentDescriptionroot.MuiStep-root'li'The component that renders the root.indicator.MuiStep-indicator'div'The component that renders the indicator.CSS classesView:table

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.Mui-activeClass name applied to the root element if active is true..Mui-completedClass name applied to the root element if completed is true..Mui-disabledClass name applied to the root element if disabled is true..MuiStep-horizontalhorizontalClass name applied to the root element if orientation="horizontal"..MuiStep-verticalverticalClass 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. Source code

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

Edit this page

Was this page helpful?

StackStepButton

•

Blog

•

Store

Contents

DemosImportPropsactivechildrencompletedcomponentdisabledindicatororientationslotPropsslotssxSlotsrootindicatorCSS classesactivecompleteddisabledhorizontalverticalSource codeBecome a Diamond sponsorMUI stands in solidarity with Ukraine.Search…