279 lines
No EOL
9.5 KiB
JavaScript
279 lines
No EOL
9.5 KiB
JavaScript
'use client';
|
|
|
|
import * as React from 'react';
|
|
import PropTypes from 'prop-types';
|
|
import clsx from 'clsx';
|
|
import composeClasses from '@mui/utils/composeClasses';
|
|
import SwitchBase from "../internal/SwitchBase.js";
|
|
import CheckBoxOutlineBlankIcon from "../internal/svg-icons/CheckBoxOutlineBlank.js";
|
|
import CheckBoxIcon from "../internal/svg-icons/CheckBox.js";
|
|
import IndeterminateCheckBoxIcon from "../internal/svg-icons/IndeterminateCheckBox.js";
|
|
import capitalize from "../utils/capitalize.js";
|
|
import rootShouldForwardProp from "../styles/rootShouldForwardProp.js";
|
|
import checkboxClasses, { getCheckboxUtilityClass } from "./checkboxClasses.js";
|
|
import { styled } from "../zero-styled/index.js";
|
|
import memoTheme from "../utils/memoTheme.js";
|
|
import createSimplePaletteValueFilter from "../utils/createSimplePaletteValueFilter.js";
|
|
import { useDefaultProps } from "../DefaultPropsProvider/index.js";
|
|
import { mergeSlotProps } from "../utils/index.js";
|
|
import useSlot from "../utils/useSlot.js";
|
|
import { jsx as _jsx } from "react/jsx-runtime";
|
|
const useUtilityClasses = ownerState => {
|
|
const {
|
|
classes,
|
|
indeterminate,
|
|
color,
|
|
size
|
|
} = ownerState;
|
|
const slots = {
|
|
root: ['root', indeterminate && 'indeterminate', `color${capitalize(color)}`, `size${capitalize(size)}`]
|
|
};
|
|
const composedClasses = composeClasses(slots, getCheckboxUtilityClass, classes);
|
|
return {
|
|
...classes,
|
|
// forward the disabled and checked classes to the SwitchBase
|
|
...composedClasses
|
|
};
|
|
};
|
|
const CheckboxRoot = styled(SwitchBase, {
|
|
shouldForwardProp: prop => rootShouldForwardProp(prop) || prop === 'classes',
|
|
name: 'MuiCheckbox',
|
|
slot: 'Root',
|
|
overridesResolver: (props, styles) => {
|
|
const {
|
|
ownerState
|
|
} = props;
|
|
return [styles.root, ownerState.indeterminate && styles.indeterminate, styles[`size${capitalize(ownerState.size)}`], ownerState.color !== 'default' && styles[`color${capitalize(ownerState.color)}`]];
|
|
}
|
|
})(memoTheme(({
|
|
theme
|
|
}) => ({
|
|
color: (theme.vars || theme).palette.text.secondary,
|
|
variants: [{
|
|
props: {
|
|
color: 'default',
|
|
disableRipple: false
|
|
},
|
|
style: {
|
|
'&:hover': {
|
|
backgroundColor: theme.alpha((theme.vars || theme).palette.action.active, (theme.vars || theme).palette.action.hoverOpacity)
|
|
}
|
|
}
|
|
}, ...Object.entries(theme.palette).filter(createSimplePaletteValueFilter()).map(([color]) => ({
|
|
props: {
|
|
color,
|
|
disableRipple: false
|
|
},
|
|
style: {
|
|
'&:hover': {
|
|
backgroundColor: theme.alpha((theme.vars || theme).palette[color].main, (theme.vars || theme).palette.action.hoverOpacity)
|
|
}
|
|
}
|
|
})), ...Object.entries(theme.palette).filter(createSimplePaletteValueFilter()).map(([color]) => ({
|
|
props: {
|
|
color
|
|
},
|
|
style: {
|
|
[`&.${checkboxClasses.checked}, &.${checkboxClasses.indeterminate}`]: {
|
|
color: (theme.vars || theme).palette[color].main
|
|
},
|
|
[`&.${checkboxClasses.disabled}`]: {
|
|
color: (theme.vars || theme).palette.action.disabled
|
|
}
|
|
}
|
|
})), {
|
|
// Should be last to override other colors
|
|
props: {
|
|
disableRipple: false
|
|
},
|
|
style: {
|
|
// Reset on touch devices, it doesn't add specificity
|
|
'&:hover': {
|
|
'@media (hover: none)': {
|
|
backgroundColor: 'transparent'
|
|
}
|
|
}
|
|
}
|
|
}]
|
|
})));
|
|
const defaultCheckedIcon = /*#__PURE__*/_jsx(CheckBoxIcon, {});
|
|
const defaultIcon = /*#__PURE__*/_jsx(CheckBoxOutlineBlankIcon, {});
|
|
const defaultIndeterminateIcon = /*#__PURE__*/_jsx(IndeterminateCheckBoxIcon, {});
|
|
const Checkbox = /*#__PURE__*/React.forwardRef(function Checkbox(inProps, ref) {
|
|
const props = useDefaultProps({
|
|
props: inProps,
|
|
name: 'MuiCheckbox'
|
|
});
|
|
const {
|
|
checkedIcon = defaultCheckedIcon,
|
|
color = 'primary',
|
|
icon: iconProp = defaultIcon,
|
|
indeterminate = false,
|
|
indeterminateIcon: indeterminateIconProp = defaultIndeterminateIcon,
|
|
inputProps,
|
|
size = 'medium',
|
|
disableRipple = false,
|
|
className,
|
|
slots = {},
|
|
slotProps = {},
|
|
...other
|
|
} = props;
|
|
const icon = indeterminate ? indeterminateIconProp : iconProp;
|
|
const indeterminateIcon = indeterminate ? indeterminateIconProp : checkedIcon;
|
|
const ownerState = {
|
|
...props,
|
|
disableRipple,
|
|
color,
|
|
indeterminate,
|
|
size
|
|
};
|
|
const classes = useUtilityClasses(ownerState);
|
|
const externalInputProps = slotProps.input ?? inputProps;
|
|
const [RootSlot, rootSlotProps] = useSlot('root', {
|
|
ref,
|
|
elementType: CheckboxRoot,
|
|
className: clsx(classes.root, className),
|
|
shouldForwardComponentProp: true,
|
|
externalForwardedProps: {
|
|
slots,
|
|
slotProps,
|
|
...other
|
|
},
|
|
ownerState,
|
|
additionalProps: {
|
|
type: 'checkbox',
|
|
icon: /*#__PURE__*/React.cloneElement(icon, {
|
|
fontSize: icon.props.fontSize ?? size
|
|
}),
|
|
checkedIcon: /*#__PURE__*/React.cloneElement(indeterminateIcon, {
|
|
fontSize: indeterminateIcon.props.fontSize ?? size
|
|
}),
|
|
disableRipple,
|
|
slots,
|
|
slotProps: {
|
|
input: mergeSlotProps(typeof externalInputProps === 'function' ? externalInputProps(ownerState) : externalInputProps, {
|
|
'data-indeterminate': indeterminate
|
|
})
|
|
}
|
|
}
|
|
});
|
|
return /*#__PURE__*/_jsx(RootSlot, {
|
|
...rootSlotProps,
|
|
classes: classes
|
|
});
|
|
});
|
|
process.env.NODE_ENV !== "production" ? Checkbox.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`. │
|
|
// └─────────────────────────────────────────────────────────────────────┘
|
|
/**
|
|
* If `true`, the component is checked.
|
|
*/
|
|
checked: PropTypes.bool,
|
|
/**
|
|
* The icon to display when the component is checked.
|
|
* @default <CheckBoxIcon />
|
|
*/
|
|
checkedIcon: PropTypes.node,
|
|
/**
|
|
* Override or extend the styles applied to the component.
|
|
*/
|
|
classes: PropTypes.object,
|
|
/**
|
|
* @ignore
|
|
*/
|
|
className: PropTypes.string,
|
|
/**
|
|
* The color of the component.
|
|
* It supports both default and custom theme colors, which can be added as shown in the
|
|
* [palette customization guide](https://mui.com/material-ui/customization/palette/#custom-colors).
|
|
* @default 'primary'
|
|
*/
|
|
color: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['default', 'primary', 'secondary', 'error', 'info', 'success', 'warning']), PropTypes.string]),
|
|
/**
|
|
* The default checked state. Use when the component is not controlled.
|
|
*/
|
|
defaultChecked: PropTypes.bool,
|
|
/**
|
|
* If `true`, the component is disabled.
|
|
* @default false
|
|
*/
|
|
disabled: PropTypes.bool,
|
|
/**
|
|
* If `true`, the ripple effect is disabled.
|
|
* @default false
|
|
*/
|
|
disableRipple: PropTypes.bool,
|
|
/**
|
|
* The icon to display when the component is unchecked.
|
|
* @default <CheckBoxOutlineBlankIcon />
|
|
*/
|
|
icon: PropTypes.node,
|
|
/**
|
|
* The id of the `input` element.
|
|
*/
|
|
id: PropTypes.string,
|
|
/**
|
|
* If `true`, the component appears indeterminate.
|
|
* This does not set the native input element to indeterminate due
|
|
* to inconsistent behavior across browsers.
|
|
* However, we set a `data-indeterminate` attribute on the `input`.
|
|
* @default false
|
|
*/
|
|
indeterminate: PropTypes.bool,
|
|
/**
|
|
* The icon to display when the component is indeterminate.
|
|
* @default <IndeterminateCheckBoxIcon />
|
|
*/
|
|
indeterminateIcon: PropTypes.node,
|
|
/**
|
|
* [Attributes](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#attributes) applied to the `input` element.
|
|
* @deprecated Use `slotProps.input` 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.
|
|
*/
|
|
inputProps: PropTypes.object,
|
|
/**
|
|
* Callback fired when the state is changed.
|
|
*
|
|
* @param {React.ChangeEvent<HTMLInputElement>} event The event source of the callback.
|
|
* You can pull out the new checked state by accessing `event.target.checked` (boolean).
|
|
*/
|
|
onChange: PropTypes.func,
|
|
/**
|
|
* If `true`, the `input` element is required.
|
|
* @default false
|
|
*/
|
|
required: PropTypes.bool,
|
|
/**
|
|
* The size of the component.
|
|
* `small` is equivalent to the dense checkbox styling.
|
|
* @default 'medium'
|
|
*/
|
|
size: PropTypes /* @typescript-to-proptypes-ignore */.oneOfType([PropTypes.oneOf(['medium', 'small']), PropTypes.string]),
|
|
/**
|
|
* The props used for each slot inside.
|
|
* @default {}
|
|
*/
|
|
slotProps: PropTypes.shape({
|
|
input: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
|
|
root: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
|
|
}),
|
|
/**
|
|
* The components used for each slot inside.
|
|
* @default {}
|
|
*/
|
|
slots: PropTypes.shape({
|
|
input: PropTypes.elementType,
|
|
root: PropTypes.elementType
|
|
}),
|
|
/**
|
|
* 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]),
|
|
/**
|
|
* The value of the component. The DOM API casts this to a string.
|
|
* The browser uses "on" as the default value.
|
|
*/
|
|
value: PropTypes.any
|
|
} : void 0;
|
|
export default Checkbox; |