amis/docs/zh-CN/components/form/switch.md
崔鹤 2b98caa50c
feat: Switch 组件功能对齐4.0规范 (#3154)
1.trueValue/falseValue 类型 ang---->boolean | string | number
2.onText/offText 类型string---->ReactNode
3.规范开关icon为svg时的样式

Co-authored-by: cuihe <cuihe@baidu.com>
2021-12-14 12:14:47 +08:00

2.0 KiB
Executable File
Raw Blame History

title description type group menuName icon order
Switch 开关 0 null Switch 51

基本用法

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
        {
            "name": "switch",
            "type": "switch",
            "label": "开关",
            "option": "开关说明"
        }
    ]
}

配置真假值

默认情况:

  • 开关打开时表单项值为true
  • 开关关闭时表单项值为false
{
    "type": "form",
    "debug": true,
    "body": [
        {
            "name": "switch",
            "type": "switch",
            "label": "开关"
        }
    ]
}

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

{
    "type": "form",
    "debug": true,
    "body": [
        {
            "name": "switch",
            "type": "switch",
            "label": "开关",
            "trueValue": 1,
            "falseValue": 0
        }
    ]
}

调整开关,观察数据域变化,会发现打开后值为1,而关闭后为0

配置开启和关闭状态的文本

1.1.5 版本之后支持

{
    "type": "form",
    "body": [
        {
            "name": "switch",
            "type": "switch",
            "onText": "已开启飞行模式",
            "offText": "已关闭飞行模式"
        }
    ]
}

属性表

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

属性名 类型 默认值 说明
option string 选项说明
onText string 开启时的文本
offText string 关闭时的文本
trueValue boolean / string / number true 标识真值
falseValue boolean / string / number "false" 标识假值