| 1 | import * as React from 'react';
|
| 2 | import { StandardProps } from '..';
|
| 3 | import { StepIconProps } from '../StepIcon';
|
| 4 |
|
| 5 | export interface StepLabelProps
|
| 6 | extends StandardProps<React.HTMLAttributes<HTMLDivElement>, StepLabelClasskey> {
|
| 7 | /**
|
| 8 | * In most cases will simply be a string containing a title for the label.
|
| 9 | */
|
| 10 | children?: React.ReactNode;
|
| 11 | /**
|
| 12 | * Mark the step as disabled, will also disable the button if
|
| 13 | * `StepLabelButton` is a child of `StepLabel`. Is passed to child components.
|
| 14 | */
|
| 15 | disabled?: boolean;
|
| 16 | /**
|
| 17 | * Mark the step as failed.
|
| 18 | */
|
| 19 | error?: boolean;
|
| 20 | /**
|
| 21 | * Override the default label of the step icon.
|
| 22 | */
|
| 23 | icon?: React.ReactNode;
|
| 24 | /**
|
| 25 | * The optional node to display.
|
| 26 | */
|
| 27 | optional?: React.ReactNode;
|
| 28 | /**
|
| 29 | * The component to render in place of the [`StepIcon`](/api/step-icon/).
|
| 30 | */
|
| 31 | StepIconComponent?: React.ElementType;
|
| 32 | /**
|
| 33 | * Props applied to the [`StepIcon`](/api/step-icon/) element.
|
| 34 | */
|
| 35 | StepIconProps?: Partial<StepIconProps>;
|
| 36 | }
|
| 37 |
|
| 38 | export type StepLabelClasskey =
|
| 39 | | 'root'
|
| 40 | | 'horizontal'
|
| 41 | | 'vertical'
|
| 42 | | 'active'
|
| 43 | | 'completed'
|
| 44 | | 'alternativeLabel'
|
| 45 | | 'error'
|
| 46 | | 'disabled'
|
| 47 | | 'label'
|
| 48 | | 'iconContainer'
|
| 49 | | 'labelContainer';
|
| 50 |
|
| 51 | /**
|
| 52 | *
|
| 53 | * Demos:
|
| 54 | *
|
| 55 | * - [Steppers](https://mui.com/components/steppers/)
|
| 56 | *
|
| 57 | * API:
|
| 58 | *
|
| 59 | * - [StepLabel API](https://mui.com/api/step-label/)
|
| 60 | */
|
| 61 | export default function StepLabel(props: StepLabelProps): JSX.Element;
|