Skip to content

StepButton API

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

Component demos

Import

import StepButton from '@mui/material/StepButton';
// or
import { StepButton } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the ButtonBase component are also available.

children

Can be a StepLabel or a node to place inside StepLabel as children.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

icon

The icon displayed by the step label.

Type:node

optional

The optional node to display.

Type:node

sx

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.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in StepButton. You can take advantage of this to target nested components.

Theme default props

You can use MuiStepButton to change the default props of this component with the theme.

CSS classes

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

.MuiStepButton-horizontal

Styles applied to the root element if orientation="horizontal".

Rule name:horizontal

.MuiStepButton-root

Styles applied to the root element.

Rule name:root

.MuiStepButton-touchRipple

Styles applied to the ButtonBase touch-ripple.

Rule name:touchRipple

.MuiStepButton-vertical

Styles 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: