@mui/material/Stepper/Stepper.d.ts

React components that implement Google's Material Design.

import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { Theme } from '../styles';
import { PaperProps } from '../Paper';
import { StepperClasses } from './stepperClasses';

export type Orientation = 'horizontal' | 'vertical';

export interface StepperTypeMap<P = {}, D extends React.ElementType = 'div'> {
  props: P &
    Pick<PaperProps, 'elevation' | 'square' | 'variant'> & {
      /**
       * Set the active step (zero based index).
       * Set to -1 to disable all the steps.
       * @default 0
       */
      activeStep?: number;
      /**
       * If set to 'true' and orientation is horizontal,
       * then the step label will be positioned under the icon.
       * @default false
       */
      alternativeLabel?: boolean;
      /**
       * Two or more `<Step />` components.
       */
      children?: React.ReactNode;
      /**
       * Override or extend the styles applied to the component.
       */
      classes?: Partial<StepperClasses>;
      /**
       * An element to be placed between each step.
       * @default <StepConnector />
       */
      connector?: React.ReactElement<any, any> | null;
      /**
       * If set the `Stepper` will not assist in controlling steps for linear flow.
       * @default false
       */
      nonLinear?: boolean;
      /**
       * The component orientation (layout flow direction).
       * @default 'horizontal'
       */
      orientation?: Orientation;
      /**
       * The system prop that allows defining system overrides as well as additional CSS styles.
       */
      sx?: SxProps<Theme>;
    };
  defaultComponent: D;
}

export type StepperProps<
  D extends React.ElementType = StepperTypeMap['defaultComponent'],
  P = { component?: React.ElementType },
> = OverrideProps<StepperTypeMap<P, D>, D>;

export type StepperClasskey = keyof NonNullable<StepperProps['classes']>;

/**
 *
 * Demos:
 *
 * - [Stepper](https://mui.com/material-ui/react-stepper/)
 *
 * API:
 *
 * - [Stepper API](https://mui.com/material-ui/api/stepper/)
 */
declare const Stepper: OverridableComponent<StepperTypeMap>;

export default Stepper;