51 lines
1.2 KiB
TypeScript
51 lines
1.2 KiB
TypeScript
|
import * as React from 'react';
|
||
|
|
import { SxProps } from '@mui/system';
|
||
|
|
import { InternalStandardProps as StandardProps } from '..';
|
||
|
|
import { Theme } from '../styles';
|
||
|
|
import { StepIconClasses } from './stepIconClasses';
|
||
|
|
|
||
|
|
export interface StepIconProps
|
||
|
|
extends StandardProps<React.HTMLAttributes<HTMLDivElement>, 'children'> {
|
||
|
|
/**
|
||
|
|
* Whether this step is active.
|
||
|
|
* @default false
|
||
|
|
*/
|
||
|
|
active?: boolean;
|
||
|
|
/**
|
||
|
|
* Override or extend the styles applied to the component.
|
||
|
|
*/
|
||
|
|
classes?: Partial<StepIconClasses>;
|
||
|
|
/**
|
||
|
|
* Mark the step as completed. Is passed to child components.
|
||
|
|
* @default false
|
||
|
|
*/
|
||
|
|
completed?: boolean;
|
||
|
|
/**
|
||
|
|
* If `true`, the step is marked as failed.
|
||
|
|
* @default false
|
||
|
|
*/
|
||
|
|
error?: boolean;
|
||
|
|
/**
|
||
|
|
* The label displayed in the step icon.
|
||
|
|
*/
|
||
|
|
icon: React.ReactNode;
|
||
|
|
/**
|
||
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
||
|
|
*/
|
||
|
|
sx?: SxProps<Theme>;
|
||
|
|
}
|
||
|
|
|
||
|
|
export type StepIconClasskey = keyof NonNullable<StepIconProps['classes']>;
|
||
|
|
|
||
|
|
/**
|
||
|
|
*
|
||
|
|
* Demos:
|
||
|
|
*
|
||
|
|
* - [Stepper](https://mui.com/material-ui/react-stepper/)
|
||
|
|
*
|
||
|
|
* API:
|
||
|
|
*
|
||
|
|
* - [StepIcon API](https://mui.com/material-ui/api/step-icon/)
|
||
|
|
*/
|
||
|
|
export default function StepIcon(props: StepIconProps): JSX.Element;
|