amis/docs/zh-CN/components/form/checkbox.md
吴多益 c8c4b6efa3
文档文字小调整;统一删掉 schema 中的高度设置;修复 tinymce 弹窗可能被遮挡问题 (#1336)
* 文档优化

* 文档细节调整,删除示例的 height 设置,使用自动撑开

* sdk 使用完整例子,因为新版没发布

* 修复官网语言不正确问题

* 增加 icon 调整颜色及大小的例子

* 修复文字错误

* 补充 each 的文档

* 修复 zh-CN 大写问题
2021-01-07 23:35:03 +08:00

1.7 KiB
Executable File
Raw Blame History

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

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

基本用法

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

配置真假值

默认情况:

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

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

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

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

属性表

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

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