StepButton API
API documentation for the React StepButton component. Learn about the available props and the CSS API.
Import
import StepButton from '@mui/material/StepButton';
// or
import { StepButton } from '@mui/material';
Component name
The nameMuiStepButton
can be used when providing default props or style overrides in the theme.Props
Props of the ButtonBase component are also available.
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. | |
sx | 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 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 global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.