amis/docs/components/form/checkbox.md

80 lines
1.8 KiB
Markdown
Raw Normal View History

2020-07-28 10:03:53 +08:00
---
title: Checkbox 勾选框
description:
type: 0
group: null
menuName: Checkbox
icon:
order: 8
---
## 基本用法
```schema:height="300" scope="body"
{
"type": "form",
"controls": [
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框",
"option": "选项说明"
}
]
}
```
## 配置真假值
默认情况:
- 勾选框勾选时表单项值为true
- 勾选框取消勾选时表单项值为false
```schema:height="300" scope="body"
{
"type": "form",
"debug": true,
"controls": [
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框"
}
]
}
```
如果你想调整这个值,可以配置`trueValue`和`falseValue`
```schema:height="300" scope="body"
{
"type": "form",
"debug": true,
"controls": [
{
"name": "checkbox",
"type": "checkbox",
"label": "勾选框",
"trueValue": 1,
"falseValue": 0
}
]
}
```
勾选上例中的勾选框,观察数据域变化,会发现勾选后值为`1`,而取消勾选后为`0`
## 属性表
除了支持 [普通表单项属性表](./formitem#%E5%B1%9E%E6%80%A7%E8%A1%A8) 中的配置以外,还支持下面一些配置
| 属性名 | 类型 | 默认值 | 说明 ## 二级标题 |
| ---------- | -------- | --------- | ----------------------------------------------------------- |
| option | `string` | | 选项说明 |
| trueValue | `any` | `true` | 标识真值 |
| falseValue | `any` | `"false"` | 标识假值 |