amis2/docs/zh-CN/components/form/checkbox.md

115 lines
3.0 KiB
Markdown
Raw Normal View History

2020-07-28 10:03:53 +08:00
---
title: Checkbox 勾选框
2021-01-04 20:10:08 +08:00
description:
2020-07-28 10:03:53 +08:00
type: 0
group: null
menuName: Checkbox
2021-01-04 20:10:08 +08:00
icon:
2020-07-28 10:03:53 +08:00
order: 8
---
2021-01-04 20:10:08 +08:00
用于实现勾选,功能和 [Switch](./switch) 类似,只是展现上不同。
2020-07-28 10:03:53 +08:00
## 基本用法
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "form",
"body": [
2020-07-28 10:03:53 +08:00
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框",
"option": "选项说明"
}
]
}
```
## 配置真假值
默认情况:
2021-01-04 20:10:08 +08:00
2020-07-28 10:03:53 +08:00
- 勾选框勾选时表单项值为true
- 勾选框取消勾选时表单项值为false
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "form",
"debug": true,
"body": [
2020-07-28 10:03:53 +08:00
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框"
}
]
}
```
如果你想调整这个值,可以配置`trueValue`和`falseValue`
```schema: scope="body"
2020-07-28 10:03:53 +08:00
{
"type": "form",
"debug": true,
"body": [
2020-07-28 10:03:53 +08:00
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框",
"trueValue": 1,
"falseValue": 0
}
]
}
```
勾选上例中的勾选框,观察数据域变化,会发现勾选后值为`1`,而取消勾选后为`0`
2022-03-06 21:49:08 +08:00
## 按钮模式
2022-03-06 21:49:08 +08:00
```schema: scope="body"
{
"type": "form",
"debug": true,
"body": [
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框",
"trueValue": true,
"falseValue": false,
"optionType": "button",
"option": "选项说明",
"value": true
2022-03-06 21:49:08 +08:00
}
]
}
```
2020-07-28 10:03:53 +08:00
## 属性表
除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外,还支持下面一些配置
| 属性名 | 类型 | 默认值 | 说明 |
| ---------- | ------------------------- | --------- | ---------------- |
| option | `string` | | 选项说明 |
| trueValue | `stringnumberboolean` | `true` | 标识真值 |
| falseValue | `stringnumberboolean` | `false` | 标识假值 |
| optionType | `defaultbutton` | `default` | 设置 option 类型 |
2022-03-16 10:12:21 +08:00
## 事件表
| 事件名称 | 事件参数 | 说明 |
| -------- | ------------------------- | ---------------------- |
| change | `value: boolean` 选中状态 | 选中状态发生变化时触发 |
2022-03-16 10:12:21 +08:00
## 动作表
| 动作名称 | 动作配置 | 说明 |
| -------- | ------------------------------------------- | ------------------------------------------------------ |
| clear | - | 清空 |
| reset | - | 将值重置为`resetValue`,若没有配置`resetValue`,则清空 |
| setValue | `value: string \|number \|boolean` 更新的值 | 更新数据 |