StepLabel API
API reference docs for the React StepLabel 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 StepLabel from '@mui/material/StepLabel';
// or
import { StepLabel } from '@mui/material';
Component name
The nameMuiStepLabel
can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
children | node | In most cases will simply be a string containing a title for the label. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
componentsProps | { label?: object } | {} | The props used for each slot inside. |
error | bool | false | If true , the step is marked as failed. |
icon | node | Override the default label of the step icon. | |
optional | node | The optional node to display. | |
slotProps | { label?: object } | {} | The props used for each slot inside. |
StepIconComponent | elementType | The component to render in place of the StepIcon . | |
StepIconProps | object | Props applied to the StepIcon element. | |
sx | Array<func | object | bool> | func | 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.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiStepLabel-root | Styles applied to the root element. |
horizontal | .MuiStepLabel-horizontal | Styles applied to the root element if orientation="horizontal" . |
vertical | .MuiStepLabel-vertical | Styles applied to the root element if orientation="vertical" . |
label | .MuiStepLabel-label | Styles applied to the label element that wraps `children`. |
active | .Mui-active | State class applied to the label element if active={true} . |
completed | .Mui-completed | State class applied to the label element if completed={true} . |
error | .Mui-error | State class applied to the root and label elements if error={true} . |
disabled | .Mui-disabled | State class applied to the root and label elements if disabled={true} . |
iconContainer | .MuiStepLabel-iconContainer | Styles applied to the `icon` container element. |
alternativeLabel | .MuiStepLabel-alternativeLabel | State class applied to the root and icon container and label if alternativeLabel={true} . |
labelContainer | .MuiStepLabel-labelContainer | Styles applied to the container element which wraps label and `optional`. |
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.