复选框API

React Checkbox 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

有关此 React 组件用法的示例和详细信息，请访问组件演示页面

导入

import Checkbox from '@mui/material/Checkbox';
// or
import { Checkbox } from '@mui/material';

通过阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

ButtonBase 组件的 props 也可用。

名称	类型	默认值	描述
checked	布尔值	-	如果为 `true`，则组件被选中。
checkedIcon	节点	<CheckBoxIcon />	组件选中时显示的图标。
classes	对象	-	覆盖或扩展应用于组件的样式。有关更多详细信息，请参见下方的 CSS 类 API。
颜色	'default' \| 'primary' \| 'secondary' \| 'error' \| 'info' \| 'success' \| 'warning' \| 字符串	'primary'	组件的颜色。它支持默认主题颜色和自定义主题颜色，自定义主题颜色可以按照调色板自定义指南中所示的方式添加。
defaultChecked	布尔值	-	默认的选中状态。当组件不受控制时使用。
disabled	布尔值	false	如果为 `true`，则组件被禁用。
disableRipple	布尔值	false	如果为 `true`，则禁用涟漪效果。
icon	节点	<CheckBoxOutlineBlankIcon />	组件未选中时显示的图标。
id	字符串	-	`input` 元素的 id。
indeterminate	布尔值	false	如果为 `true`，则组件显示为不确定状态。由于浏览器之间行为不一致，这不会将原生 input 元素设置为不确定状态。但是，我们在 `input` 上设置了一个 `data-indeterminate` 属性。
indeterminateIcon	节点	<IndeterminateCheckBoxIcon />	组件处于不确定状态时显示的图标。
inputProps	对象	-	应用于 `input` 元素的属性。已弃用－请改用 `slotProps.input`。此 prop 将在 v7 中移除。有关更多详细信息，请参阅从已弃用的 API 迁移。
onChange	函数	-	状态更改时触发的回调。签名：`function(event: React.ChangeEvent) => void` `event` 回调的事件源。您可以通过访问 `event.target.checked` (布尔值) 来获取新的选中状态。
required	布尔值	false	如果为 `true`，则 `input` 元素为必填项。
size	'medium' \| 'small' \| 字符串	'medium'	组件的大小。`small` 相当于紧凑型复选框样式。
slotProps	{ input?: 函数 \| 对象, root?: 函数 \| 对象 }	{}	用于每个插槽内部的 props。
slots	{ input?: 元素类型, root?: 元素类型 }	{}	用于每个插槽内部的组件。
sx	数组<函数 \| 对象 \| 布尔值> \| 函数 \| 对象	-	允许定义系统覆盖以及其他 CSS 样式的系统 prop。有关更多详细信息，请参见 `sx` 页面。
value	任意类型	-	组件的值。DOM API 将其转换为字符串。浏览器使用 “on” 作为默认值。

ref 被转发到根元素。

继承

虽然上面没有明确文档说明，但 ButtonBase 组件的 props 也可在 Checkbox 中使用。您可以利用这一点来定位嵌套组件。

主题默认 props

您可以使用 MuiCheckbox 通过主题更改此组件的默认 props。

插槽

插槽名称	类名	默认组件	描述
root	.MuiCheckbox-root	`SwitchBase`	渲染 root 插槽的组件。
input		`SwitchBase 的 input`	渲染 input 插槽的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置非常有用。当触发特定状态时，它们会应用于组件的插槽。

类名	规则名称	描述
.Mui-checked		如果 `checked={true}`，则应用于根元素的状态类。
.Mui-disabled		如果 `disabled={true}`，则应用于根元素的状态类。
.MuiCheckbox-colorPrimary	colorPrimary	如果 `color="primary"`，则应用于根元素的状态类。
.MuiCheckbox-colorSecondary	colorSecondary	如果 `color="secondary"`，则应用于根元素的状态类。
.MuiCheckbox-indeterminate	indeterminate	如果 `indeterminate={true}`，则应用于根元素的状态类。
.MuiCheckbox-sizeMedium	sizeMedium	如果 `size="medium"`，则应用于根元素的状态类。
.MuiCheckbox-sizeSmall	sizeSmall	如果 `size="small"`，则应用于根元素的状态类。

您可以使用以下自定义选项之一来覆盖组件的样式

使用全局类名。
在自定义主题中，使用规则名称作为组件 styleOverrides 属性的一部分。

源代码

如果您在此页面中没有找到所需信息，请考虑查看组件的实现代码以获取更多详细信息。