UNPKG

1.05 kBTypeScriptView Raw
1import * as React from 'react';
2import { StandardProps } from '..';
3import { Orientation } from '../Stepper';
4
5export interface StepProps
6 extends StandardProps<React.HTMLAttributes<HTMLDivElement>, StepClasskey> {
7 /**
8 * Sets the step as active. Is passed to child components.
9 */
10 active?: boolean;
11 /**
12 * Should be `Step` sub-components such as `StepLabel`, `StepContent`.
13 */
14 children?: React.ReactNode;
15 /**
16 * Mark the step as completed. Is passed to child components.
17 */
18 completed?: boolean;
19 /**
20 * Mark the step as disabled, will also disable the button if
21 * `StepButton` is a child of `Step`. Is passed to child components.
22 */
23 disabled?: boolean;
24 /**
25 * Expand the step.
26 */
27 expanded?: boolean;
28}
29
30export type StepClasskey = 'root' | 'horizontal' | 'vertical' | 'alternativeLabel' | 'completed';
31
32/**
33 *
34 * Demos:
35 *
36 * - [Steppers](https://mui.com/components/steppers/)
37 *
38 * API:
39 *
40 * - [Step API](https://mui.com/api/step/)
41 */
42export default function Step(props: StepProps): JSX.Element;