Skip to content

StepButton API

The API documentation of the StepButton React component. Learn more about the props and the CSS customization points.

import { StepButton } from '@material-ui/core';

Props

Name Type Default 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).

CSS

  • Style sheet name: MuiStepButton.
  • Style sheet details:
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 thanks to one of these customization points:

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

Inheritance

The props of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.

Notes

The component is fully StrictMode compatible.

Demos