UNPKG

1.36 kBTypeScriptView Raw
1import * as React from 'react';
2export interface ProgressStepProps extends React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement> {
3 /** Content rendered inside the progress step. */
4 children?: React.ReactNode;
5 /** Additional classes applied to the progress step container. */
6 className?: string;
7 /** Variant of the progress step. Each variant has a default icon. */
8 variant?: 'default' | 'success' | 'info' | 'pending' | 'warning' | 'danger';
9 /** Flag indicating the progress step is the current step. */
10 isCurrent?: boolean;
11 /** Custom icon of a progress step. Will override default icons provided by the variant. */
12 icon?: React.ReactNode;
13 /** Description text of a progress step. */
14 description?: string;
15 /** ID of the title of the progress step. */
16 titleId?: string;
17 /** Accessible label for the progress step. Should communicate all information being communicated by the progress
18 * step's icon, including the variant and the completed status. */
19 'aria-label'?: string;
20 /** Forwards the step ref to rendered function. Use this prop to add a popover to the step.*/
21 popoverRender?: (stepRef: React.RefObject<any>) => React.ReactNode;
22}
23export declare const ProgressStep: React.FunctionComponent<ProgressStepProps>;
24//# sourceMappingURL=ProgressStep.d.ts.map
\No newline at end of file