ant-design/components/checkbox/index.zh-CN.md

65 lines
2.0 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 多选框
type: 数据录入
2016-09-21 11:28:38 +08:00
title: Checkbox
2016-03-31 14:17:09 +08:00
---
2015-07-15 15:19:24 +08:00
多选框。
## 何时使用
- 在一组可选项中进行多项选择时;
- 单独使用可以表示两种状态之间的切换,和 `switch` 类似。区别在于切换 `switch` 会直接触发状态改变,而 `checkbox` 一般用于状态标记,需要和提交操作配合。
2015-07-15 15:19:24 +08:00
## API
2018-06-03 16:28:10 +08:00
### 属性
#### Checkbox
2015-07-15 15:19:24 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| -------------- | --------------------------------------- | ----------------- | ------ | ---- |
| autoFocus | 自动获取焦点 | boolean | false | |
| checked | 指定当前是否选中 | boolean | false | |
| defaultChecked | 初始是否选中 | boolean | false | |
| disabled | 失效状态 | boolean | false | |
| indeterminate | 设置 indeterminate 状态,只负责样式控制 | boolean | false | |
| onChange | 变化时回调函数 | Function(e:Event) | - | |
2015-12-24 15:03:06 +08:00
2018-06-03 16:28:10 +08:00
#### Checkbox Group
2015-12-24 15:03:06 +08:00
| 参数 | 说明 | 类型 | 默认值 | 版本 |
| --- | --- | --- | --- | --- |
| defaultValue | 默认选中的选项 | string\[] | \[] | |
| disabled | 整组失效 | boolean | false | |
| name | CheckboxGroup 下所有 `input[type="checkbox"]``name` 属性 | string | - | |
2019-12-01 21:46:17 +08:00
| options | 指定可选项 | string\[] \| Option\[] | \[] | |
| value | 指定选中的选项 | string\[] | \[] | |
| onChange | 变化时回调函数 | Function(checkedValue) | - | |
2019-12-01 15:46:17 +08:00
##### Option
```typescript
interface Option {
label: string;
value: string;
disabled?: boolean;
}
```
2018-06-03 16:28:10 +08:00
### 方法
2018-06-03 16:28:10 +08:00
#### Checkbox
| 名称 | 描述 | 版本 |
| ------- | -------- | ---- |
| blur() | 移除焦点 | |
| focus() | 获取焦点 | |
2019-12-23 20:07:56 +08:00
<style>
.site-checkbox-all-wrapper {
border-bottom: 1px solid #303030;
}
</style>