Skip to content

StepButton API

API documentation for the React StepButton component. Learn about the available props, and the CSS API.

Import

import StepButton from '@material-ui/core/StepButton';
// or
import { StepButton } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiStepButton can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
childrennodeCan be a StepLabel or a node to place inside StepLabel as children.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
iconnodeThe icon displayed by the step label.
optionalnodeThe optional node to display.
sxobjectThe 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.
Any other props supplied will be provided to the root element (ButtonBase).

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiStepButton-rootStyles applied to the root element.
horizontal.MuiStepButton-horizontalStyles applied to the root element if orientation="horizontal".
vertical.MuiStepButton-verticalStyles applied to the root element if orientation="vertical".
touchRipple.MuiStepButton-touchRippleStyles applied to the `ButtonBase` touch-ripple.

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

Demos