37 lines
800 B
TypeScript
37 lines
800 B
TypeScript
import * as React from 'react';
|
|
import { StandardProps } from '..';
|
|
|
|
export interface StepIconProps
|
|
extends StandardProps<React.HTMLAttributes<HTMLDivElement>, StepIconClasskey, 'children'> {
|
|
/**
|
|
* Whether this step is active.
|
|
*/
|
|
active?: boolean;
|
|
/**
|
|
* Mark the step as completed. Is passed to child components.
|
|
*/
|
|
completed?: boolean;
|
|
/**
|
|
* Mark the step as failed.
|
|
*/
|
|
error?: boolean;
|
|
/**
|
|
* The label displayed in the step icon.
|
|
*/
|
|
icon: React.ReactNode;
|
|
}
|
|
|
|
export type StepIconClasskey = 'root' | 'text' | 'active' | 'completed' | 'error';
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Steppers](https://mui.com/components/steppers/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [StepIcon API](https://mui.com/api/step-icon/)
|
|
*/
|
|
export default function StepIcon(props: StepIconProps): JSX.Element;
|