复选框
选择相互独立的选项,或反映汇总项的部分选中状态。
本指南覆盖默认 Emotion 环境的 Material UI Core;扩展包与额外示例按清单单独标注。
使用场景与业务边界
indeterminate 是视觉状态,与 checked 不同;汇总选择和校验由宿主计算。
原生组成与范围
Checkbox, FormControl, FormGroup, FormLabel, FormControlLabel
保持 Material UI 原生组合与类型,不替换为 JGuang/Base UI/Radix 同名 API。示例条目不是额外组件。
原生安装与初始化
npm install @mui/material@9.4.0 @emotion/react@11.14.0 @emotion/styled@11.14.1
采用原生 npm 包与 Emotion,不提供虚构的 JGuang UI Registry 地址。将示例放在原生 ThemeProvider 内,按项目选择 CssBaseline 或 ScopedCssBaseline。先检查 React、现有 Provider、锁文件与 SSR 配置;不要覆盖用户文件或忽略 peer 冲突。本批实际验收 React 19.2.8;React 18 及以下须匹配 react-is。完整初始化规则见随附的双语 setup 文档。
关键原生参数
仅解释本指南选出的关键参数,不是平铺的通用 API。原生继承来源、slot 结构、可空值与泛型仍按固定源码保留。
| 所属组件.属性 | 用途说明 | 声明来源 |
|---|---|---|
Checkbox.checked | 受控二元选择,与原生变化回调配套。 | Checkbox |
Checkbox.indeterminate | 汇总项部分选中的视觉状态,与 checked 分开。 | Checkbox |
Checkbox.onChange | 所属控件的原生回调,保留其准确事件/数值/可空签名。 | Checkbox |
Checkbox.disabled | 原生禁用交互状态,不是权限校验。 | Checkbox |
可运行原生示例
下列机器键只选择示例入口,不会作为通用 variant 属性传入每个组件。原生示例 JSX 与数据保持上游原文;JGuang 编写的验收示例明确标注。
- 基础复选框 ·
Checkboxes· 上游原生示例 - 文字标签 ·
CheckboxLabels· 上游原生示例 - 尺寸 ·
SizeCheckboxes· 上游原生示例 - 颜色 ·
ColorCheckboxes· 上游原生示例 - 图标 ·
IconCheckboxes· 上游原生示例 - 受控状态 ·
ControlledCheckbox· 上游原生示例 - 部分选中 ·
IndeterminateCheckbox· 上游原生示例 - 表单分组 ·
CheckboxesGroup· 上游原生示例 - 标签位置 ·
FormControlLabelPosition· 上游原生示例 - 定制样式 ·
CustomizedCheckbox· 上游原生示例
真实使用示例
固定版本的未修改原生示例;复制时同时保留所需的局部辅助文件。
import Checkbox from '@mui/material/Checkbox';
const label = { slotProps: { input: { 'aria-label': 'Checkbox demo' } } };
export default function Checkboxes() {
return (
<div>
<Checkbox {...label} defaultChecked />
<Checkbox {...label} />
<Checkbox {...label} disabled />
<Checkbox {...label} disabled checked />
</div>
);
}
示例依赖边界
@mui/material/Checkbox, @mui/material/FormGroup, @mui/material/FormControlLabel, @mui/material/colors, @mui/icons-material/FavoriteBorder, @mui/icons-material/Favorite, @mui/icons-material/BookmarkBorder, @mui/icons-material/Bookmark, react, @mui/material/Box, @mui/material/FormLabel, @mui/material/FormControl, @mui/material/FormHelperText, @mui/material/styles
直接导入 Icons/System/Utils 的示例需要匹配 9.4.0 包。局部数据与辅助文件属于示例闭包,不是额外组件。远程图片和模拟操作不提供后端。
固定上游 API 元数据参考
以下表格保留上游元数据,不是重新推断的通用类型体系。条件泛型、继承属性与回调细节以以下源码声明为准。主题默认配置可能覆盖元数据默认值。
Checkbox
import Checkbox from '@mui/material/Checkbox';
import { Checkbox } from '@mui/material';
原生继承: ButtonBase. 父级与 DOM 属性未被伪造为本组件新属性。
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
checked | 否 | bool | — |
checkedIcon | 否 | node | <CheckBoxIcon /> |
classes | 否 | object | — |
color | 否 | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' |
defaultChecked | 否 | bool | — |
disabled | 否 | bool | false |
disableRipple | 否 | bool | false |
icon | 否 | node | <CheckBoxOutlineBlankIcon /> |
id | 否 | string | — |
indeterminate | 否 | bool | false |
indeterminateIcon | 否 | node | <IndeterminateCheckBoxIcon /> |
onChange | 否 | func | — |
required | 否 | bool | false |
size | 否 | 'medium' | 'small' | string | 'medium' |
slotProps | 否 | { input?: func | object, root?: func | object } | {} |
slots | 否 | { input?: elementType, root?: elementType } | {} |
sx | 否 | Array<func | object | bool> | func | object | — |
value | 否 | any | — |
FormControl
import FormControl from '@mui/material/FormControl';
import { FormControl } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'primary' |
component | 否 | elementType | — |
disabled | 否 | bool | false |
error | 否 | bool | false |
focused | 否 | bool | — |
fullWidth | 否 | bool | false |
hiddenLabel | 否 | bool | false |
margin | 否 | 'dense' | 'none' | 'normal' | 'none' |
required | 否 | bool | false |
size | 否 | 'medium' | 'small' | string | 'medium' |
sx | 否 | Array<func | object | bool> | func | object | — |
variant | 否 | 'filled' | 'outlined' | 'standard' | 'outlined' |
FormGroup
import FormGroup from '@mui/material/FormGroup';
import { FormGroup } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
row | 否 | bool | false |
sx | 否 | Array<func | object | bool> | func | object | — |
FormLabel
import FormLabel from '@mui/material/FormLabel';
import { FormLabel } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
children | 否 | node | — |
classes | 否 | object | — |
color | 否 | 'error' | 'info' | 'primary' | 'secondary' | 'success' | 'warning' | string | — |
component | 否 | elementType | — |
disabled | 否 | bool | — |
error | 否 | bool | — |
filled | 否 | bool | — |
focused | 否 | bool | — |
required | 否 | bool | — |
sx | 否 | Array<func | object | bool> | func | object | — |
FormControlLabel
import FormControlLabel from '@mui/material/FormControlLabel';
import { FormControlLabel } from '@mui/material';
| 属性 | 必需 | 上游元数据类型/约束 | 元数据默认值 |
|---|---|---|---|
control | 是 | element | — |
checked | 否 | bool | — |
classes | 否 | object | — |
disabled | 否 | bool | — |
disableTypography | 否 | bool | — |
inputRef | 否 | ref | — |
label | 否 | node | — |
labelPlacement | 否 | 'bottom' | 'end' | 'start' | 'top' | 'end' |
onChange | 否 | func | — |
required | 否 | bool | — |
slotProps | 否 | { typography?: func | object } | {} |
slots | 否 | { typography?: elementType } | {} |
sx | 否 | Array<func | object | bool> | func | object | — |
value | 否 | any | — |
原生源码声明
声明与 import 从固定源码提取,不平铺联合类型或外部继承。英文注释/类型属于原始源码参考,不代表上游正文已全文翻译。共享类型仍位于原生包中。
vendor/src/Checkbox/Checkbox.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { InternalStandardProps as StandardProps } from '../internal';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
import { SwitchBaseProps } from '../internal/SwitchBase';
import { CheckboxClasses } from './checkboxClasses';
export interface CheckboxPropsSizeOverrides {}
export interface CheckboxPropsColorOverrides {}
export interface CheckboxRootSlotPropsOverrides {}
export interface CheckboxInputSlotPropsOverrides {}
export interface CheckboxSlots {
/**
* The component that renders the root slot.
* @default SwitchBase
*/
root: React.ElementType;
/**
* The component that renders the input slot.
* @default SwitchBase's input
*/
input: React.ElementType;
}
export type CheckboxSlotsAndSlotProps = CreateSlotsAndSlotProps<
CheckboxSlots,
{
/**
* Props forwarded to the root slot.
* By default, the available props are based on the div element.
*/
root: SlotProps<
React.ElementType<SwitchBaseProps>,
CheckboxRootSlotPropsOverrides,
CheckboxOwnerState
>;
/**
* Props forwarded to the input slot.
* By default, the available props are based on the input element.
*/
input: SlotProps<'input', CheckboxInputSlotPropsOverrides, CheckboxOwnerState>;
}
>;
export interface CheckboxProps
extends
StandardProps<
SwitchBaseProps,
'checkedIcon' | 'color' | 'icon' | 'type' | 'slots' | 'slotProps'
>,
CheckboxSlotsAndSlotProps {
/**
* If `true`, the component is checked.
*/
checked?: SwitchBaseProps['checked'] | undefined;
/**
* The icon to display when the component is checked.
* @default <CheckBoxIcon />
*/
checkedIcon?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<CheckboxClasses> | undefined;
/**
* 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?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | 'default',
CheckboxPropsColorOverrides
>
| undefined;
/**
* If `true`, the component is disabled.
* @default false
*/
disabled?: SwitchBaseProps['disabled'] | undefined;
/**
* If `true`, the ripple effect is disabled.
* @default false
*/
disableRipple?: SwitchBaseProps['disableRipple'] | undefined;
/**
* The icon to display when the component is unchecked.
* @default <CheckBoxOutlineBlankIcon />
*/
icon?: React.ReactNode;
/**
* The id of the `input` element.
*/
id?: SwitchBaseProps['id'] | undefined;
/**
* 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?: boolean | undefined;
/**
* The icon to display when the component is indeterminate.
* @default <IndeterminateCheckBoxIcon />
*/
indeterminateIcon?: React.ReactNode;
/**
* 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?: SwitchBaseProps['onChange'] | undefined;
/**
* If `true`, the `input` element is required.
* @default false
*/
required?: SwitchBaseProps['required'] | undefined;
/**
* The size of the component.
* `small` is equivalent to the dense checkbox styling.
* @default 'medium'
*/
size?:
OverridableStringUnion<'small' | 'medium' | 'large', CheckboxPropsSizeOverrides> | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The value of the component. The DOM API casts this to a string.
* The browser uses "on" as the default value.
*/
value?: SwitchBaseProps['value'] | undefined;
}
export interface CheckboxOwnerState extends Omit<CheckboxProps, 'slots' | 'slotProps'> {}
export default function Checkbox(props: CheckboxProps): React.JSX.Element;
vendor/src/FormControl/FormControl.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { OverridableComponent, OverrideProps } from '../OverridableComponent';
import { Theme } from '../styles';
import { FormControlClasses } from './formControlClasses';
export interface FormControlPropsSizeOverrides {}
export interface FormControlPropsColorOverrides {}
export interface FormControlOwnProps {
/**
* The content of the component.
*/
children?: React.HTMLAttributes<HTMLDivElement>['children'] | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormControlClasses> | undefined;
/**
* 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?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
FormControlPropsColorOverrides
>
| undefined;
/**
* If `true`, the label, input and helper text should be displayed in a disabled state.
* @default false
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is displayed in an error state.
* @default false
*/
error?: boolean | undefined;
/**
* If `true`, the component will take up the full width of its container.
* @default false
*/
fullWidth?: boolean | undefined;
/**
* If `true`, the component is displayed in focused state.
*/
focused?: boolean | undefined;
/**
* If `true`, the label is hidden.
* This is used to increase density for a `FilledInput`.
* Be sure to add `aria-label` to the `input` element.
* @default false
*/
hiddenLabel?: boolean | undefined;
/**
* If `dense` or `normal`, will adjust vertical spacing of this and contained components.
* @default 'none'
*/
margin?: 'dense' | 'normal' | 'none' | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
* @default false
*/
required?: boolean | undefined;
/**
* The size of the component.
* @default 'medium'
*/
size?: OverridableStringUnion<'small' | 'medium', FormControlPropsSizeOverrides> | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The variant to use.
* @default 'outlined'
*/
variant?: 'standard' | 'outlined' | 'filled' | undefined;
}
export interface FormControlTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'div',
> {
props: AdditionalProps & FormControlOwnProps;
defaultComponent: RootComponent;
}
declare const FormControl: OverridableComponent<FormControlTypeMap>;
export type FormControlProps<
RootComponent extends React.ElementType = FormControlTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<FormControlTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/FormGroup/FormGroup.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { Theme } from '../styles';
import { InternalStandardProps as StandardProps } from '../internal';
import { FormGroupClasses } from './formGroupClasses';
export interface FormGroupProps extends StandardProps<React.HTMLAttributes<HTMLDivElement>> {
/**
* The content of the component.
*/
children?: React.ReactNode;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormGroupClasses> | undefined;
/**
* Display group of elements in a compact row.
* @default false
*/
row?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export default function FormGroup(props: FormGroupProps): React.JSX.Element;
vendor/src/FormLabel/FormLabel.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { OverridableStringUnion } from '@mui/types';
import { Theme } from '../styles';
import { OverridableComponent, OverrideProps, OverridableTypeMap } from '../OverridableComponent';
import { FormLabelClasses } from './formLabelClasses';
export interface FormLabelPropsColorOverrides {}
export type FormLabelBaseProps = React.LabelHTMLAttributes<HTMLLabelElement>;
export interface FormLabelOwnProps {
/**
* The content of the component.
*/
children?: React.LabelHTMLAttributes<HTMLLabelElement>['children'] | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormLabelClasses> | undefined;
/**
* 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).
*/
color?:
| OverridableStringUnion<
'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning',
FormLabelPropsColorOverrides
>
| undefined;
/**
* If `true`, the label should be displayed in a disabled state.
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is displayed in an error state.
*/
error?: boolean | undefined;
/**
* If `true`, the label should use filled classes key.
*/
filled?: boolean | undefined;
/**
* If `true`, the input of this label is focused (used by `FormGroup` components).
*/
focused?: boolean | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
*/
required?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
}
export interface FormLabelTypeMap<
AdditionalProps = {},
RootComponent extends React.ElementType = 'label',
> {
props: AdditionalProps & FormLabelBaseProps & FormLabelOwnProps;
defaultComponent: RootComponent;
}
declare const FormLabel: OverridableComponent<FormLabelTypeMap>;
export interface ExtendFormLabelTypeMap<TypeMap extends OverridableTypeMap> {
props: TypeMap['props'] & Pick<FormLabelOwnProps, 'filled' | 'color'>;
defaultComponent: TypeMap['defaultComponent'];
}
export type FormLabelProps<
RootComponent extends React.ElementType = FormLabelTypeMap['defaultComponent'],
AdditionalProps = {},
> = OverrideProps<FormLabelTypeMap<AdditionalProps, RootComponent>, RootComponent> & {
component?: React.ElementType | undefined;
};
vendor/src/FormControlLabel/FormControlLabel.d.ts
import * as React from 'react';
import { SxProps } from '@mui/system';
import { Theme } from '../styles';
import { InternalStandardProps as StandardProps } from '../internal';
import Typography from '../Typography';
import { FormControlLabelClasses } from './formControlLabelClasses';
import { CreateSlotsAndSlotProps, SlotProps } from '../utils/types';
export interface FormControlLabelSlots {
/**
* The component that renders the label.
* This is unused if `disableTypography` is true.
* @default Typography
*/
typography: React.ElementType;
}
export type FormControlLabelSlotsAndSlotProps = CreateSlotsAndSlotProps<
FormControlLabelSlots,
{
typography: SlotProps<typeof Typography, {}, FormControlLabelProps>;
}
>;
export interface FormControlLabelProps
extends
StandardProps<React.LabelHTMLAttributes<HTMLLabelElement>, 'children' | 'onChange'>,
FormControlLabelSlotsAndSlotProps {
/**
* If `true`, the component appears selected.
*/
checked?: boolean | undefined;
/**
* Override or extend the styles applied to the component.
*/
classes?: Partial<FormControlLabelClasses> | undefined;
/**
* A control element. For instance, it can be a `Radio`, a `Switch` or a `Checkbox`.
*/
control: React.ReactElement<unknown, any>;
/**
* If `true`, the control is disabled.
*/
disabled?: boolean | undefined;
/**
* If `true`, the label is rendered as it is passed without an additional typography node.
*/
disableTypography?: boolean | undefined;
/**
* Pass a ref to the `input` element.
*/
inputRef?: React.Ref<any> | undefined;
/**
* A text or an element to be used in an enclosing label element.
*/
label: React.ReactNode;
/**
* The position of the label.
* @default 'end'
*/
labelPlacement?: 'end' | 'start' | 'top' | 'bottom' | undefined;
name?: string | undefined;
/**
* Callback fired when the state is changed.
*
* @param {React.SyntheticEvent} event The event source of the callback.
* You can pull out the new checked state by accessing `event.target.checked` (boolean).
*/
onChange?: ((event: React.SyntheticEvent, checked: boolean) => void) | undefined;
/**
* If `true`, the label will indicate that the `input` is required.
*/
required?: boolean | undefined;
/**
* The system prop that allows defining system overrides as well as additional CSS styles.
*/
sx?: SxProps<Theme> | undefined;
/**
* The value of the component.
*/
value?: unknown;
}
export default function FormControlLabel(props: FormControlLabelProps): React.JSX.Element;
安装后验收
执行严格类型检查、生产构建和实际交互。检查键盘标签/焦点、原生支持的禁用/错误/只读语义、深浅色、窄屏和减少动画。按真实宿主数据检查回调,不把复制提示词当作安装完成。初始化工具还需检查服务端 HTML 与无告警水合。
来源与许可
https://github.com/mui/material-ui/tree/809a7717b4c050ba3f69b75300689f07c050a16e
MIT · @mui/material@9.4.0. 保留上游原始内容与许可证。上游完整原文保留于 vendor/docs,不标为全文中文化。