amis/docs/zh-CN/components/form/checkbox.md
liaoxuezhi 65ac422ed6
1.2.x 文档&示例配置调整 (#2064)
* 补充容错

* fix: form 中 name 关联顶层数据初始化失效

* 更新 examples

* 文档调整

* 删除多余的文档, 调整 schema

* schema 调整

* schema 调整

* control 类型容器 control 改成 body

* 修复一个选项加载的bug

* form 注册直接用 type
2021-06-07 10:09:55 +08:00

1.6 KiB
Executable File
Raw Blame History

title description type group menuName icon order
Checkbox 勾选框 0 null Checkbox 8

用于实现勾选,功能和 Switch 类似,只是展现上不同。

基本用法

{
    "type": "form",
    "body": [
        {
            "name": "checkbox",
            "type": "checkbox",
            "label": "勾选框",
            "option": "选项说明"
        }
    ]
}

配置真假值

默认情况:

  • 勾选框勾选时表单项值为true
  • 勾选框取消勾选时表单项值为false
{
    "type": "form",
    "debug": true,
    "body": [
        {
            "name": "checkbox",
            "type": "checkbox",
            "label": "勾选框"
        }
    ]
}

如果你想调整这个值,可以配置trueValuefalseValue

{
    "type": "form",
    "debug": true,
    "body": [
        {
            "name": "checkbox",
            "type": "checkbox",
            "label": "勾选框",
            "trueValue": 1,
            "falseValue": 0
        }
    ]
}

勾选上例中的勾选框,观察数据域变化,会发现勾选后值为1,而取消勾选后为0

属性表

除了支持 普通表单项属性表 中的配置以外,还支持下面一些配置

属性名 类型 默认值 说明 ## 二级标题
option string 选项说明
trueValue any true 标识真值
falseValue any "false" 标识假值