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

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 API below for more details.
icon	node	The icon displayed by the step label.
optional	node	The optional node to display.

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

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

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

If that isn't sufficient, you can check the implementation of the component for more detail.

Demos

Steppers