UNPKG

800 BTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '..';
3
4export interface StepIconProps
5 extends StandardProps<React.HTMLAttributes<HTMLDivElement>, StepIconClasskey, 'children'> {
6 /**
7 * Whether this step is active.
8 */
9 active?: boolean;
10 /**
11 * Mark the step as completed. Is passed to child components.
12 */
13 completed?: boolean;
14 /**
15 * Mark the step as failed.
16 */
17 error?: boolean;
18 /**
19 * The label displayed in the step icon.
20 */
21 icon: React.ReactNode;
22}
23
24export type StepIconClasskey = 'root' | 'text' | 'active' | 'completed' | 'error';
25
26/**
27 *
28 * Demos:
29 *
30 * - [Steppers](https://mui.com/components/steppers/)
31 *
32 * API:
33 *
34 * - [StepIcon API](https://mui.com/api/step-icon/)
35 */
36export default function StepIcon(props: StepIconProps): JSX.Element;