Skip to content
Edit this page

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:

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiStepButton-rootroot

Styles applied to the root element.

.MuiStepButton-horizontalhorizontal

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

.MuiStepButton-verticalvertical

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

.MuiStepButton-touchRippletouchRipple

Styles applied to the ButtonBase touch-ripple.

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