Checkbox 复选框

复选框允许用户从一组选项中选择一个或多个选项，或者切换单个选项的开/关状态。

使用方法

按需导入组件：

import 'mdui/components/checkbox.js';

按需导入组件的 TypeScript 类型：

import type { Checkbox } from 'mdui/components/checkbox.js';

使用示例：

Checkbox

<mdui-checkbox>Checkbox</mdui-checkbox>

示例

选中状态

复选框选中时，checked 属性值为 true。添加 checked 属性可以使复选框默认处于选中状态。

Checkbox

<mdui-checkbox checked>Checkbox</mdui-checkbox>

源码

禁用状态

添加 disabled 属性可以禁用复选框。

Checkbox

<mdui-checkbox disabled>Checkbox</mdui-checkbox>
<mdui-checkbox disabled checked>Checkbox</mdui-checkbox>

源码

不确定状态

添加 indeterminate 属性表示复选框处于不确定状态。

Checkbox

<mdui-checkbox indeterminate>Checkbox</mdui-checkbox>

源码

图标

通过设置 unchecked-icon、checked-icon、indeterminate-icon 属性，可以分别设置未选中、选中、不确定状态时的复选框的 Material Icons 图标。也可以通过 unchecked-icon、checked-icon、indeterminate-icon slot 进行设置。

Checkbox

<mdui-checkbox
  unchecked-icon="radio_button_unchecked"
  checked-icon="check_circle"
  indeterminate-icon="playlist_add_check_circle"
>Checkbox</mdui-checkbox>

<mdui-checkbox
  indeterminate
  unchecked-icon="radio_button_unchecked"
  checked-icon="check_circle"
  indeterminate-icon="playlist_add_check_circle"
>Checkbox</mdui-checkbox>

<br/>

<mdui-checkbox>
  <mdui-icon slot="unchecked-icon" name="radio_button_unchecked"></mdui-icon>
  <mdui-icon slot="checked-icon" name="check_circle"></mdui-icon>
  <mdui-icon slot="indeterminate-icon" name="playlist_add_check_circle"></mdui-icon>
  Checkbox
</mdui-checkbox>

<mdui-checkbox indeterminate>
  <mdui-icon slot="unchecked-icon" name="radio_button_unchecked"></mdui-icon>
  <mdui-icon slot="checked-icon" name="check_circle"></mdui-icon>
  <mdui-icon slot="indeterminate-icon" name="playlist_add_check_circle"></mdui-icon>
  Checkbox
</mdui-checkbox>

源码

API

属性

HTML 属性	JavaScript 属性	类型	默认值
`disabled`	`disabled`	`boolean`	`false`
是否为禁用状态
`checked`	`checked`	`boolean`	`false`
是否为选中状态
	`defaultChecked`	`boolean`	`false`
默认选中状态。在重置表单时，将恢复为此状态。此属性只能通过 JavaScript 属性设置
`indeterminate`	`indeterminate`	`boolean`	`false`
是否处于不确定状态
`required`	`required`	`boolean`	`false`
提交表单时，是否必须选中此复选框
`form`	`form`	`string`	-
关联的 `<form>` 元素。此属性值应为同一页面中的一个 `<form>` 元素的 `id`。如果未指定此属性，则该元素必须是 `<form>` 元素的子元素。通过此属性，你可以将元素放置在页面的任何位置，而不仅仅是 `<form>` 元素的子元素。
`name`	`name`	`string`	`''`
复选框名称，将与表单数据一起提交
`value`	`value`	`string`	`'on'`
复选框的值，将于表单数据一起提交
`unchecked-icon`	`uncheckedIcon`	`string`	-
未选中状态的 Material Icons 图标名。也可以通过 `slot="unchecked-icon"` 设置
`checked-icon`	`checkedIcon`	`string`	-
选中状态的 Material Icons 图标名。也可以通过 `slot="checked-icon"` 设置
`indeterminate-icon`	`indeterminateIcon`	`string`	-
不确定状态的 Material Icons 图标名。也可以通过 `slot="indeterminate-icon"` 设置
	`validity`	`ValidityState`	-
表单验证状态对象，具体参见 `ValidityState`
	`validationMessage`	`string`	-
如果表单验证未通过，此属性将包含提示信息。如果验证通过，此属性将为空字符串
`autofocus`	`autofocus`	`boolean`	`false`
是否在页面加载完成后自动获取焦点
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 键切换焦点时的顺序

方法

名称	参数	返回值
`checkValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`
`reportValidity`		`boolean`
检查表单字段是否通过验证。如果未通过，返回 `false` 并触发 `invalid` 事件；如果通过，返回 `true`。如果验证未通过，还会在组件上显示验证失败的提示。
`setCustomValidity`	`message: string`	`void`
设置自定义的错误提示文本。只要这个文本不为空，就表示字段未通过验证
`click`		`void`
模拟鼠标点击元素
`focus`	`options: FocusOptions` (可选)	`void`
将焦点设置到当前元素。可以传入一个对象作为参数，该对象的属性包括： `preventScroll`：默认情况下，元素获取焦点后，页面会滚动以将该元素滚动到视图中。如果不希望页面滚动，可以将此属性设置为 `true`。
`blur`		`void`
移除当前元素的焦点

事件

名称
`focus`
获得焦点时触发
`blur`
失去焦点时触发
`change`
选中状态变更时触发
`input`
选中状态变更时触发
`invalid`
表单字段验证未通过时触发

Slots

名称
默认
复选框文本
`unchecked-icon`
未选中状态的图标
`checked-icon`
选中状态的图标
`indeterminate-icon`
不确定状态的图标

CSS Parts

名称
`control`
左侧图标容器
`unchecked-icon`
未选中状态的图标
`checked-icon`
选中状态的图标
`indeterminate-icon`
不确定状态的图标
`label`
复选框文本

Card 卡片

Chip 纸片