UNPKG

@mui/material

Version:

Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.

70 lines (69 loc) 2.13 kB
import * as React from 'react'; import { SxProps } from '@mui/system'; import { OverridableComponent, OverrideProps } from "../OverridableComponent/index.js"; import { Theme } from "../styles/index.js"; import { StepClasses } from "./stepClasses.js"; export interface StepOwnProps { /** * Sets the step as active. Is passed to child components. */ active?: boolean; /** * Should be `Step` sub-components such as `StepLabel`, `StepContent`. */ children?: React.ReactNode; /** * Override or extend the styles applied to the component. */ classes?: Partial<StepClasses>; /** * Mark the step as completed. Is passed to child components. */ completed?: boolean; /** * If `true`, the step is disabled, will also disable the button if * `StepButton` is a child of `Step`. Is passed to child components. */ disabled?: boolean; /** * Expand the step. * @default false */ expanded?: boolean; /** * The position of the step. * The prop defaults to the value inherited from the parent Stepper component. */ index?: number; /** * If `true`, the Step is displayed as rendered last. * The prop defaults to the value inherited from the parent Stepper component. */ last?: boolean; /** * The system prop that allows defining system overrides as well as additional CSS styles. */ sx?: SxProps<Theme>; } export interface StepTypeMap<AdditionalProps = {}, RootComponent extends React.ElementType = 'div'> { props: AdditionalProps & StepOwnProps; defaultComponent: RootComponent; } export type StepProps<RootComponent extends React.ElementType = StepTypeMap['defaultComponent'], AdditionalProps = { component?: React.ElementType; }> = OverrideProps<StepTypeMap<AdditionalProps, RootComponent>, RootComponent> & { component?: React.ElementType; }; export type StepClasskey = keyof NonNullable<StepProps['classes']>; /** * * Demos: * * - [Stepper](https://mui.com/material-ui/react-stepper/) * * API: * * - [Step API](https://mui.com/material-ui/api/step/) */ declare const Step: OverridableComponent<StepTypeMap>; export default Step;