StepButton API

API reference docs for the React StepButton 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:

Stepper

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.

Name	Type	Description
children	node	Can be a `StepLabel` or a node to place inside `StepLabel` as children.
classes	object	Override or extend the styles applied to the component. See CSS classes API below for more details.
icon	node	The icon displayed by the step label.
optional	node	The optional node to display.
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.

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.

Class name	Rule name	Description
.MuiStepButton-horizontal	horizontal	Styles applied to the root element if `orientation="horizontal"`.
.MuiStepButton-root	root	Styles applied to the root element.
.MuiStepButton-touchRipple	touchRipple	Styles applied to the `ButtonBase` touch-ripple.
.MuiStepButton-vertical	vertical	Styles 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.