StepLabel

StepLabel

The API documentation of the StepLabel React component. Learn more about the properties and the CSS customization points.

import StepLabel from '@material-ui/core/StepLabel';

Props

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.
disabled bool false Mark the step as disabled, will also disable the button if StepLabelButton is a child of StepLabel. Is passed to child components.
error bool false Mark the step as failed.
icon node Override the default icon.
optional node The optional node to display.
StepIconComponent union: string |
 func |
 object
The component to render in place of the StepIcon.
StepIconProps object Properties applied to the StepIcon element.

Any other properties supplied will be spread to the root element (native element).

CSS API

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
horizontal Styles applied to the root element if `orientation="horiizontal".
vertical Styles applied to the root element if `orientation="vertical".
label Styles applied to the Typography component which wraps children.
active Styles applied to the Typography component if active={true}.
completed Styles applied to the Typography component if completed={true}.
error Styles applied to the root element and Typography component if error={true}.
disabled Styles applied to the root element and Typography component if disabled={true}.
iconContainer Styles applied to the icon container element.
alternativeLabel Styles applied to the root & icon container and Typography if alternativeLabel={true}.
labelContainer Styles applied to the container element which wraps Typography and optional.

Have a look at overriding with classes section and the implementation of the component for more detail.

If using the overrides key of the theme as documented here, you need to use the following style sheet name: MuiStepLabel.

Demos