mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-13 07:39:10 +08:00
e027cbec1c
* chore: add prettier-ignore in markdown demo * docs: format markdown api table * docs: format markdown api table
2.5 KiB
2.5 KiB
category | subtitle | group | title | cover | demo | ||
---|---|---|---|---|---|---|---|
Components | 多选框 | 数据录入 | Checkbox | https://gw.alipayobjects.com/zos/alicdn/8nbVbHEm_/CheckBox.svg |
|
多选框。
何时使用
- 在一组可选项中进行多项选择时;
- 单独使用可以表示两种状态之间的切换,和
switch
类似。区别在于切换switch
会直接触发状态改变,而checkbox
一般用于状态标记,需要和提交操作配合。
代码演示
基本用法
不可用
受控的 Checkbox
Checkbox 组
全选
布局
同行布局
API
属性
Checkbox
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
autoFocus | 自动获取焦点 | boolean | false | |
checked | 指定当前是否选中 | boolean | false | |
defaultChecked | 初始是否选中 | boolean | false | |
disabled | 失效状态 | boolean | false | |
indeterminate | 设置 indeterminate 状态,只负责样式控制 | boolean | false | |
onChange | 变化时的回调函数 | function(e:Event) | - |
Checkbox Group
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
defaultValue | 默认选中的选项 | string[] | [] | |
disabled | 整组失效 | boolean | false | |
name | CheckboxGroup 下所有 input[type="checkbox"] 的 name 属性 |
string | - | |
options | 指定可选项 | string[] | number[] | Option[] | [] | |
value | 指定选中的选项 | string[] | [] | |
onChange | 变化时的回调函数 | function(checkedValue) | - |
Option
interface Option {
label: string;
value: string;
disabled?: boolean;
}
方法
Checkbox
名称 | 描述 | 版本 |
---|---|---|
blur() | 移除焦点 | |
focus() | 获取焦点 |