106 lines
No EOL
3.7 KiB
TypeScript
106 lines
No EOL
3.7 KiB
TypeScript
import * as React from 'react';
|
|
import { SxProps } from '@mui/system';
|
|
import { Theme } from "../styles/index.js";
|
|
import { InternalStandardProps as StandardProps } from "../internal/index.js";
|
|
import { StepIconProps } from "../StepIcon/index.js";
|
|
import { StepLabelClasses } from "./stepLabelClasses.js";
|
|
import { CreateSlotsAndSlotProps, SlotProps } from "../utils/types.js";
|
|
export interface StepLabelSlots {
|
|
/**
|
|
* The component that renders the root.
|
|
* @default span
|
|
*/
|
|
root: React.ElementType;
|
|
/**
|
|
* The component that renders the label.
|
|
* @default span
|
|
*/
|
|
label: React.ElementType;
|
|
/**
|
|
* The component to render in place of the [`StepIcon`](https://mui.com/material-ui/api/step-icon/).
|
|
*/
|
|
stepIcon: React.ElementType;
|
|
}
|
|
export type StepLabelSlotsAndSlotProps = CreateSlotsAndSlotProps<StepLabelSlots, {
|
|
/**
|
|
* Props forwarded to the root slot.
|
|
* By default, the avaible props are based on the span element.
|
|
*/
|
|
root: SlotProps<'span', {}, StepLabelOwnerState>;
|
|
/**
|
|
* Props forwarded to the label slot.
|
|
* By default, the avaible props are based on the span element.
|
|
*/
|
|
label: SlotProps<'span', {}, StepLabelOwnerState>;
|
|
/**
|
|
* Props forwarded to the stepIcon slot.
|
|
* By default, the avaible props are based on the div element.
|
|
*/
|
|
stepIcon: SlotProps<React.ElementType<StepIconProps>, {}, StepLabelOwnerState>;
|
|
}>;
|
|
export interface StepLabelOwnerState extends StepLabelProps {}
|
|
export interface StepLabelProps extends StandardProps<React.HTMLAttributes<HTMLDivElement>>, StepLabelSlotsAndSlotProps {
|
|
/**
|
|
* In most cases will simply be a string containing a title for the label.
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes?: Partial<StepLabelClasses>;
|
|
/**
|
|
* The props used for each slot inside.
|
|
* @default {}
|
|
* @deprecated use the `slotProps` prop instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](https://mui.com/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*/
|
|
componentsProps?: {
|
|
/**
|
|
* Props applied to the label element.
|
|
* @default {}
|
|
*/
|
|
label?: React.HTMLProps<HTMLSpanElement>;
|
|
};
|
|
/**
|
|
* If `true`, the step is marked as failed.
|
|
* @default false
|
|
*/
|
|
error?: boolean;
|
|
/**
|
|
* Override the default label of the step icon.
|
|
*/
|
|
icon?: React.ReactNode;
|
|
/**
|
|
* The optional node to display.
|
|
*/
|
|
optional?: React.ReactNode;
|
|
/**
|
|
* The component to render in place of the [`StepIcon`](https://mui.com/material-ui/api/step-icon/).
|
|
* @deprecated Use `slots.stepIcon` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*/
|
|
StepIconComponent?: React.ElementType<StepIconProps>;
|
|
/**
|
|
* Props applied to the [`StepIcon`](https://mui.com/material-ui/api/step-icon/) element.
|
|
* @deprecated Use `slotProps.stepIcon` instead. This prop will be removed in a future major release. See [Migrating from deprecated APIs](/material-ui/migration/migrating-from-deprecated-apis/) for more details.
|
|
*/
|
|
StepIconProps?: Partial<StepIconProps>;
|
|
/**
|
|
* The system prop that allows defining system overrides as well as additional CSS styles.
|
|
*/
|
|
sx?: SxProps<Theme>;
|
|
}
|
|
export type StepLabelClasskey = keyof NonNullable<StepLabelProps['classes']>;
|
|
|
|
/**
|
|
*
|
|
* Demos:
|
|
*
|
|
* - [Stepper](https://mui.com/material-ui/react-stepper/)
|
|
*
|
|
* API:
|
|
*
|
|
* - [StepLabel API](https://mui.com/material-ui/api/step-label/)
|
|
*/
|
|
declare const StepLabel: ((props: StepLabelProps) => React.JSX.Element) & {
|
|
muiName: string;
|
|
};
|
|
export default StepLabel; |