@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.
280 lines (279 loc) • 8.91 kB
JavaScript
'use client';
import composeClasses from '@mui/utils/composeClasses';
import clsx from 'clsx';
import PropTypes from 'prop-types';
import * as React from 'react';
import StepContext from "../Step/StepContext.js";
import StepIcon from "../StepIcon/index.js";
import StepperContext from "../Stepper/StepperContext.js";
import { styled } from "../zero-styled/index.js";
import memoTheme from "../utils/memoTheme.js";
import { useDefaultProps } from "../DefaultPropsProvider/index.js";
import stepLabelClasses, { getStepLabelUtilityClass } from "./stepLabelClasses.js";
import useSlot from "../utils/useSlot.js";
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
const useUtilityClasses = ownerState => {
const {
classes,
orientation,
active,
completed,
error,
disabled,
alternativeLabel
} = ownerState;
const slots = {
root: ['root', orientation, error && 'error', disabled && 'disabled', alternativeLabel && 'alternativeLabel'],
label: ['label', active && 'active', completed && 'completed', error && 'error', disabled && 'disabled', alternativeLabel && 'alternativeLabel'],
iconContainer: ['iconContainer', active && 'active', completed && 'completed', error && 'error', disabled && 'disabled', alternativeLabel && 'alternativeLabel'],
labelContainer: ['labelContainer', alternativeLabel && 'alternativeLabel']
};
return composeClasses(slots, getStepLabelUtilityClass, classes);
};
const StepLabelRoot = styled('span', {
name: 'MuiStepLabel',
slot: 'Root',
overridesResolver: (props, styles) => {
const {
ownerState
} = props;
return [styles.root, styles[ownerState.orientation]];
}
})({
display: 'flex',
alignItems: 'center',
[`&.${stepLabelClasses.alternativeLabel}`]: {
flexDirection: 'column'
},
[`&.${stepLabelClasses.disabled}`]: {
cursor: 'default'
},
variants: [{
props: {
orientation: 'vertical'
},
style: {
textAlign: 'left',
padding: '8px 0'
}
}]
});
const StepLabelLabel = styled('span', {
name: 'MuiStepLabel',
slot: 'Label',
overridesResolver: (props, styles) => styles.label
})(memoTheme(({
theme
}) => ({
...theme.typography.body2,
display: 'block',
transition: theme.transitions.create('color', {
duration: theme.transitions.duration.shortest
}),
[`&.${stepLabelClasses.active}`]: {
color: (theme.vars || theme).palette.text.primary,
fontWeight: 500
},
[`&.${stepLabelClasses.completed}`]: {
color: (theme.vars || theme).palette.text.primary,
fontWeight: 500
},
[`&.${stepLabelClasses.alternativeLabel}`]: {
marginTop: 16
},
[`&.${stepLabelClasses.error}`]: {
color: (theme.vars || theme).palette.error.main
}
})));
const StepLabelIconContainer = styled('span', {
name: 'MuiStepLabel',
slot: 'IconContainer',
overridesResolver: (props, styles) => styles.iconContainer
})({
flexShrink: 0,
display: 'flex',
paddingRight: 8,
[`&.${stepLabelClasses.alternativeLabel}`]: {
paddingRight: 0
}
});
const StepLabelLabelContainer = styled('span', {
name: 'MuiStepLabel',
slot: 'LabelContainer',
overridesResolver: (props, styles) => styles.labelContainer
})(memoTheme(({
theme
}) => ({
width: '100%',
color: (theme.vars || theme).palette.text.secondary,
[`&.${stepLabelClasses.alternativeLabel}`]: {
textAlign: 'center'
}
})));
const StepLabel = /*#__PURE__*/React.forwardRef(function StepLabel(inProps, ref) {
const props = useDefaultProps({
props: inProps,
name: 'MuiStepLabel'
});
const {
children,
className,
componentsProps = {},
error = false,
icon: iconProp,
optional,
slots = {},
slotProps = {},
StepIconComponent: StepIconComponentProp,
StepIconProps,
...other
} = props;
const {
alternativeLabel,
orientation
} = React.useContext(StepperContext);
const {
active,
disabled,
completed,
icon: iconContext
} = React.useContext(StepContext);
const icon = iconProp || iconContext;
let StepIconComponent = StepIconComponentProp;
if (icon && !StepIconComponent) {
StepIconComponent = StepIcon;
}
const ownerState = {
...props,
active,
alternativeLabel,
completed,
disabled,
error,
orientation
};
const classes = useUtilityClasses(ownerState);
const externalForwardedProps = {
slots,
slotProps: {
stepIcon: StepIconProps,
...componentsProps,
...slotProps
}
};
const [RootSlot, rootProps] = useSlot('root', {
elementType: StepLabelRoot,
externalForwardedProps: {
...externalForwardedProps,
...other
},
ownerState,
ref,
className: clsx(classes.root, className)
});
const [LabelSlot, labelProps] = useSlot('label', {
elementType: StepLabelLabel,
externalForwardedProps,
ownerState
});
const [StepIconSlot, stepIconProps] = useSlot('stepIcon', {
elementType: StepIconComponent,
externalForwardedProps,
ownerState
});
return /*#__PURE__*/_jsxs(RootSlot, {
...rootProps,
children: [icon || StepIconSlot ? /*#__PURE__*/_jsx(StepLabelIconContainer, {
className: classes.iconContainer,
ownerState: ownerState,
children: /*#__PURE__*/_jsx(StepIconSlot, {
completed: completed,
active: active,
error: error,
icon: icon,
...stepIconProps
})
}) : null, /*#__PURE__*/_jsxs(StepLabelLabelContainer, {
className: classes.labelContainer,
ownerState: ownerState,
children: [children ? /*#__PURE__*/_jsx(LabelSlot, {
...labelProps,
className: clsx(classes.label, labelProps?.className),
children: children
}) : null, optional]
})]
});
});
process.env.NODE_ENV !== "production" ? StepLabel.propTypes /* remove-proptypes */ = {
// ┌────────────────────────────── Warning ──────────────────────────────┐
// │ These PropTypes are generated from the TypeScript type definitions. │
// │ To update them, edit the d.ts file and run `pnpm proptypes`. │
// └─────────────────────────────────────────────────────────────────────┘
/**
* In most cases will simply be a string containing a title for the label.
*/
children: PropTypes.node,
/**
* Override or extend the styles applied to the component.
*/
classes: PropTypes.object,
/**
* @ignore
*/
className: PropTypes.string,
/**
* 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: PropTypes.shape({
label: PropTypes.object
}),
/**
* If `true`, the step is marked as failed.
* @default false
*/
error: PropTypes.bool,
/**
* Override the default label of the step icon.
*/
icon: PropTypes.node,
/**
* The optional node to display.
*/
optional: PropTypes.node,
/**
* The props used for each slot inside.
* @default {}
*/
slotProps: PropTypes.shape({
label: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
root: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
stepIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
}),
/**
* The components used for each slot inside.
* @default {}
*/
slots: PropTypes.shape({
label: PropTypes.elementType,
root: PropTypes.elementType,
stepIcon: PropTypes.elementType
}),
/**
* 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: PropTypes.elementType,
/**
* 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: PropTypes.object,
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx: PropTypes.oneOfType([PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.func, PropTypes.object, PropTypes.bool])), PropTypes.func, PropTypes.object])
} : void 0;
StepLabel.muiName = 'StepLabel';
export default StepLabel;