amis2/docs-old/renderers/Form/Select.md
2020-07-28 10:03:53 +08:00

3.3 KiB
Raw Blame History

Select

选项表单。

  • type 请设置成 select
  • options 选项配置,类型为数组,成员格式如下。
    • label 文字
    • value
  • value 设置默认值,如果想要默认选中某个,请设置默认值。
  • source Api 地址,如果选项不固定,可以通过配置 source 动态拉取。另外也可以用 $xxxx 来获取当前作用域中的变量。
  • autoComplete 跟 source 不同的是,每次用户输入都会去接口获取提示。
  • multiple 默认为 false, 设置成 true 表示可多选。
  • joinValues 默认为 true
  • 单选模式:当用户选中某个选项时,选项中的 value 将被作为该表单项的值提交,否则,整个选项对象都会作为该表单项的值提交。
  • 多选模式:选中的多个选项的 value 会通过 delimiter 连接起来,否则直接将以数组的形式提交值。
  • extractValue 默认为 false, joinValues设置为false时生效, 开启后将选中的选项 value 的值封装为数组,作为当前表单项的值。
  • delimiter 默认为 ,
  • clearable 默认为 false, 当设置为 true 时,已选中的选项右侧会有个小 X 用来取消设置。
  • searchable 默认为 false,当设置为 true 时表示可以通过输入部分内容检索出选项。
  • checkAll 默认为 false 开启后支持全选
  • checkAllLabel 默认为 全选, 全选的文字
  • defaultCheckAll 是否默认全选,默认为false
  • autoFill 将当前已选中的选项的某个字段的值自动填充到表单中某个表单项中,只在单选时有效
    • 配置"autoFill": {"address": "${label}"},表示将选中项中的label的值,自动填充到当前nameaddress的表单项中
  • 还有更多通用配置请参考 FormItem

单选

[
    {
      "type": "select",
      "name": "select",
      "label": "单选",
      "clearable": true,
      "options": [
        {
          "label": "Option A",
          "value": "a"
        },
        {
          "label": "Option B",
          "value": "b"
        }
      ]
    },

    {
      "type": "static",
      "name": "select",
      "label": "当前值"
    }
]

多选

[
    {
      "type": "select",
      "name": "select",
      "label": "多选",
      "clearable": true,
      "multiple": true,
      "options": [
        {
          "label": "OptionA",
          "value": "a"
        },
        {
          "label": "OptionB",
          "value": "b"
        },
        {
          "label": "OptionC",
          "value": "c"
        },
        {
          "label": "OptionD",
          "value": "d"
        }
      ]
    },

    {
      "type": "static",
      "name": "select",
      "label": "当前值"
    }
]

接口说明

开始之前请你先阅读整体要求

source

发送

默认 GET不携带数据可从上下文中取数据设置进去。

响应

格式要求如下:

{
  "status": 0,
  "msg": "",
  "data": {
    "options": [
      {
        "label": "描述",
        "value": "值"
      },

      {
        "label": "描述2",
        "value": "值2"
      }
    ],

    "value": "值" // 默认值,可以获取列表的同时设置默认值。
  }
}