1 | import * as React from 'react';
|
2 | import { StandardProps } from '..';
|
3 | import { PaperProps } from '../Paper';
|
4 |
|
5 | export type Orientation = 'horizontal' | 'vertical';
|
6 |
|
7 | export interface StepperProps extends StandardProps<PaperProps, StepperClasskey> {
|
8 | /**
|
9 | * Set the active step (zero based index).
|
10 | * Set to -1 to disable all the steps.
|
11 | */
|
12 | activeStep?: number;
|
13 | /**
|
14 | * If set to 'true' and orientation is horizontal,
|
15 | * then the step label will be positioned under the icon.
|
16 | */
|
17 | alternativeLabel?: boolean;
|
18 | /**
|
19 | * Two or more `<Step />` components.
|
20 | */
|
21 | children: React.ReactNode;
|
22 | /**
|
23 | * An element to be placed between each step.
|
24 | */
|
25 | connector?: React.ReactElement<any, any>;
|
26 | /**
|
27 | * If set the `Stepper` will not assist in controlling steps for linear flow.
|
28 | */
|
29 | nonLinear?: boolean;
|
30 | /**
|
31 | * The stepper orientation (layout flow direction).
|
32 | */
|
33 | orientation?: Orientation;
|
34 | }
|
35 |
|
36 | export type StepperClasskey = 'root' | 'horizontal' | 'vertical' | 'alternativeLabel';
|
37 |
|
38 | /**
|
39 | *
|
40 | * Demos:
|
41 | *
|
42 | * - [Steppers](https://material-ui.com/components/steppers/)
|
43 | *
|
44 | * API:
|
45 | *
|
46 | * - [Stepper API](https://material-ui.com/api/stepper/)
|
47 | * - inherits [Paper API](https://material-ui.com/api/paper/)
|
48 | */
|
49 | export default function Stepper(props: StepperProps): JSX.Element;
|