UNPKG

1.75 kBTypeScriptView Raw
1import * as React from 'react';
2import { SxProps } from '@mui/system';
3import { InternalStandardProps as StandardProps, Theme } from '..';
4import { PaperProps } from '../Paper';
5import { LinearProgressProps } from '../LinearProgress';
6import { MobileStepperClasses } from './mobileStepperClasses';
7
8export interface MobileStepperProps extends StandardProps<PaperProps, 'children' | 'variant'> {
9 /**
10 * Set the active step (zero based index).
11 * Defines which dot is highlighted when the variant is 'dots'.
12 * @default 0
13 */
14 activeStep?: number;
15 /**
16 * A back button element. For instance, it can be a `Button` or an `IconButton`.
17 */
18 backButton: React.ReactNode;
19 /**
20 * Override or extend the styles applied to the component.
21 */
22 classes?: Partial<MobileStepperClasses>;
23 /**
24 * Props applied to the `LinearProgress` element.
25 */
26 LinearProgressProps?: Partial<LinearProgressProps>;
27 /**
28 * A next button element. For instance, it can be a `Button` or an `IconButton`.
29 */
30 nextButton: React.ReactNode;
31 /**
32 * Set the positioning type.
33 * @default 'bottom'
34 */
35 position?: 'bottom' | 'top' | 'static';
36 /**
37 * The total steps.
38 */
39 steps: number;
40 /**
41 * The system prop that allows defining system overrides as well as additional CSS styles.
42 */
43 sx?: SxProps<Theme>;
44 /**
45 * The variant to use.
46 * @default 'dots'
47 */
48 variant?: 'text' | 'dots' | 'progress';
49}
50
51/**
52 *
53 * Demos:
54 *
55 * - [Stepper](https://mui.com/material-ui/react-stepper/)
56 *
57 * API:
58 *
59 * - [MobileStepper API](https://mui.com/material-ui/api/mobile-stepper/)
60 * - inherits [Paper API](https://mui.com/material-ui/api/paper/)
61 */
62export default function MobileStepper(props: MobileStepperProps): React.JSX.Element;