Select 选择器

基本用法

参考 Options

自定义菜单

```schema: scope=”body” { “type”: “form”, “body”: [ { “label”: “选项”, “type”: “select”, “name”: “select”, “menuTpl”: “

${label} 值：${value}, 当前是否选中: ${checked}
“, “options”: [ { “label”:”A”, “value”:”a” }, { “label”:”B”, “value”:”b” }, { “label”:”C”, “value”:”c” } ] } ] }

  2. ### 分组展示模式
  4. _单选_
  6. ```schema: scope="body"
  7. {
  8.   "type": "form",
  9.   "api": "/api/mock2/form/saveForm",
  10.   "body": [
  11.     {
  12.       "label": "分组",
  13.       "type": "select",
  14.       "name": "a",
  15.       "selectMode": "group",
  16.       "options": [
  17.         {
  18.           "label": "法师",
  19.           "children": [
  20.             {
  21.               "label": "诸葛亮",
  22.               "value": "zhugeliang"
  23.             }
  24.           ]
  25.         },
  26.         {
  27.           "label": "战士",
  28.           "children": [
  29.             {
  30.               "label": "曹操",
  31.               "value": "caocao"
  32.             },
  33.             {
  34.               "label": "钟无艳",
  35.               "value": "zhongwuyan"
  36.             }
  37.           ]
  38.         },
  39.         {
  40.           "label": "打野",
  41.           "children": [
  42.             {
  43.               "label": "李白",
  44.               "value": "libai"
  45.             },
  46.             {
  47.               "label": "韩信",
  48.               "value": "hanxin"
  49.             },
  50.             {
  51.               "label": "云中君",
  52.               "value": "yunzhongjun"
  53.             }
  54.           ]
  55.         }
  56.       ]
  57.     }
  58.   ]
  59. }

多选

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “分组”, “type”: “select”, “name”: “a”, “multiple”: true, “selectMode”: “group”, “options”: [ { “label”: “法师”, “children”: [ { “label”: “诸葛亮”, “value”: “zhugeliang” } ] }, { “label”: “战士”, “children”: [ { “label”: “曹操”, “value”: “caocao” }, { “label”: “钟无艳”, “value”: “zhongwuyan” } ] }, { “label”: “打野”, “children”: [ { “label”: “李白”, “value”: “libai” }, { “label”: “韩信”, “value”: “hanxin” }, { “label”: “云中君”, “value”: “yunzhongjun” } ] } ] } ] }

  2. ### 表格模式
  4. 需要额外配置 `columns` 配置，参考 Table 中的说明。
  6. _单选_
  8. ```schema: scope="body"
  9. {
  10.   "type": "form",
  11.   "api": "/api/mock2/form/saveForm",
  12.   "body": [
  13.     {
  14.       "label": "表格形式",
  15.       "type": "select",
  16.       "name": "a",
  17.       "selectMode": "table",
  18.       "columns": [
  19.         {
  20.           "name": "label",
  21.           "label": "英雄"
  22.         },
  23.         {
  24.           "name": "position",
  25.           "label": "位置"
  26.         }
  27.       ],
  28.       "options": [
  29.         {
  30.           "label": "诸葛亮",
  31.           "value": "zhugeliang",
  32.           "position": "中单"
  33.         },
  34.         {
  35.           "label": "曹操",
  36.           "value": "caocao",
  37.           "position": "上单"
  38.         },
  39.         {
  40.           "label": "钟无艳",
  41.           "value": "zhongwuyan",
  42.           "position": "上单"
  43.         },
  44.         {
  45.           "label": "李白",
  46.           "value": "libai",
  47.           "position": "打野"
  48.         },
  49.         {
  50.           "label": "韩信",
  51.           "value": "hanxin",
  52.           "position": "打野"
  53.         },
  54.         {
  55.           "label": "云中君",
  56.           "value": "yunzhongjun",
  57.           "position": "打野"
  58.         }
  59.       ]
  60.     }
  61.   ]
  62. }

多选

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “表格形式”, “type”: “select”, “name”: “a”, “selectMode”: “table”, “multiple”: true, “columns”: [ { “name”: “label”, “label”: “英雄” }, { “name”: “position”, “label”: “位置” } ], “options”: [ { “label”: “诸葛亮”, “value”: “zhugeliang”, “position”: “中单” }, { “label”: “曹操”, “value”: “caocao”, “position”: “上单” }, { “label”: “钟无艳”, “value”: “zhongwuyan”, “position”: “上单” }, { “label”: “李白”, “value”: “libai”, “position”: “打野” }, { “label”: “韩信”, “value”: “hanxin”, “position”: “打野” }, { “label”: “云中君”, “value”: “yunzhongjun”, “position”: “打野” } ] } ] }

  2. ### 树形模式
  4. _单选_
  6. ```schema: scope="body"
  7. {
  8.   "type": "form",
  9.   "api": "/api/mock2/form/saveForm",
  10.   "body": [
  11.     {
  12.       "label": "树型展示",
  13.       "type": "select",
  14.       "name": "a",
  15.       "selectMode": "tree",
  16.       "options": [
  17.         {
  18.           "label": "法师",
  19.           "children": [
  20.             {
  21.               "label": "诸葛亮",
  22.               "value": "zhugeliang"
  23.             }
  24.           ]
  25.         },
  26.         {
  27.           "label": "战士",
  28.           "children": [
  29.             {
  30.               "label": "曹操",
  31.               "value": "caocao"
  32.             },
  33.             {
  34.               "label": "钟无艳",
  35.               "value": "zhongwuyan"
  36.             }
  37.           ]
  38.         },
  39.         {
  40.           "label": "打野",
  41.           "children": [
  42.             {
  43.               "label": "李白",
  44.               "value": "libai"
  45.             },
  46.             {
  47.               "label": "韩信",
  48.               "value": "hanxin"
  49.             },
  50.             {
  51.               "label": "云中君",
  52.               "value": "yunzhongjun"
  53.             }
  54.           ]
  55.         }
  56.       ]
  57.     }
  58.   ]
  59. }

多选

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “树型展示”, “type”: “select”, “name”: “a”, “multiple”: true, “selectMode”: “tree”, “options”: [ { “label”: “法师”, “children”: [ { “label”: “诸葛亮”, “value”: “zhugeliang” } ] }, { “label”: “战士”, “children”: [ { “label”: “曹操”, “value”: “caocao” }, { “label”: “钟无艳”, “value”: “zhongwuyan” } ] }, { “label”: “打野”, “children”: [ { “label”: “李白”, “value”: “libai” }, { “label”: “韩信”, “value”: “hanxin” }, { “label”: “云中君”, “value”: “yunzhongjun” } ] } ] } ] }

  2. ### 级联选择
  4. 按列来点选。
  6. _单选_
  8. ```schema: scope="body"
  9. {
  10.   "type": "form",
  11.   "api": "/api/mock2/form/saveForm",
  12.   "body": [
  13.     {
  14.       "label": "级联选择",
  15.       "type": "select",
  16.       "name": "a",
  17.       "selectMode": "chained",
  18.       "options": [
  19.         {
  20.           "label": "法师",
  21.           "children": [
  22.             {
  23.               "label": "诸葛亮",
  24.               "value": "zhugeliang"
  25.             }
  26.           ]
  27.         },
  28.         {
  29.           "label": "战士",
  30.           "children": [
  31.             {
  32.               "label": "曹操",
  33.               "value": "caocao"
  34.             },
  35.             {
  36.               "label": "钟无艳",
  37.               "value": "zhongwuyan"
  38.             }
  39.           ]
  40.         },
  41.         {
  42.           "label": "打野",
  43.           "children": [
  44.             {
  45.               "label": "李白",
  46.               "value": "libai"
  47.             },
  48.             {
  49.               "label": "韩信",
  50.               "value": "hanxin"
  51.             },
  52.             {
  53.               "label": "云中君",
  54.               "value": "yunzhongjun"
  55.             }
  56.           ]
  57.         }
  58.       ]
  59.     }
  60.   ]
  61. }

多选

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “级联选择”, “type”: “select”, “name”: “a”, “selectMode”: “chained”, “multiple”: true, “options”: [ { “label”: “法师”, “children”: [ { “label”: “诸葛亮”, “value”: “zhugeliang” } ] }, { “label”: “战士”, “children”: [ { “label”: “曹操”, “value”: “caocao” }, { “label”: “钟无艳”, “value”: “zhongwuyan” } ] }, { “label”: “打野”, “children”: [ { “label”: “李白”, “value”: “libai” }, { “label”: “韩信”, “value”: “hanxin” }, { “label”: “云中君”, “value”: “yunzhongjun” } ] } ] } ] }

  2. ### 支持搜索
  4. ```schema: scope="body"
  5. {
  6.   "type": "form",
  7.   "api": "/api/mock2/form/saveForm",
  8.   "body": [
  9.     {
  10.       "label": "带搜索",
  11.       "type": "select",
  12.       "name": "a",
  13.       "selectMode": "chained",
  14.       "searchable": true,
  15.       "sortable": true,
  16.       "multiple": true,
  17.       "options": [
  18.         {
  19.           "label": "法师",
  20.           "children": [
  21.             {
  22.               "label": "诸葛亮",
  23.               "value": "zhugeliang"
  24.             }
  25.           ]
  26.         },
  27.         {
  28.           "label": "战士",
  29.           "children": [
  30.             {
  31.               "label": "曹操",
  32.               "value": "caocao"
  33.             },
  34.             {
  35.               "label": "钟无艳",
  36.               "value": "zhongwuyan"
  37.             }
  38.           ]
  39.         },
  40.         {
  41.           "label": "打野",
  42.           "children": [
  43.             {
  44.               "label": "李白",
  45.               "value": "libai"
  46.             },
  47.             {
  48.               "label": "韩信",
  49.               "value": "hanxin"
  50.             },
  51.             {
  52.               "label": "云中君",
  53.               "value": "yunzhongjun"
  54.             }
  55.           ]
  56.         }
  57.       ]
  58.     }
  59.   ]
  60. }

延时加载

选型设置 defer: true，结合配置组件层的 deferApi 来实现。

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “延时加载”, “type”: “select”, “name”: “a”, “multiple”: true, “selectMode”: “tree”, “deferApi”: “/api/mock2/form/deferOptions?label=${label}&waitSeconds=2”, “options”: [ { “label”: “法师”, “children”: [ { “label”: “诸葛亮”, “value”: “zhugeliang” } ] }, { “label”: “战士”, “defer”: true }, { “label”: “打野”, “children”: [ { “label”: “李白”, “value”: “libai” }, { “label”: “韩信”, “value”: “hanxin” }, { “label”: “云中君”, “value”: “yunzhongjun” } ] } ] } ] }

  2. ### 关联选择模式
  4. 分为左右两部分，左边点选后关联出现右边。左右都可以配置展示模式。
  6. _单选_
  8. ```schema: scope="body"
  9. {
  10.   "type": "form",
  11.   "api": "/api/mock2/form/saveForm",
  12.   "body": [
  13.     {
  14.       "label": "关联选择模式",
  15.       "type": "select",
  16.       "name": "b",
  17.       "sortable": true,
  18.       "searchable": true,
  19.       "deferApi": "/api/mock2/form/deferOptions?label=${label}",
  20.       "selectMode": "associated",
  21.       "leftMode": "tree",
  22.       "leftOptions": [
  23.         {
  24.           "label": "法师",
  25.           "children": [
  26.             {
  27.               "label": "诸葛亮",
  28.               "value": "zhugeliang"
  29.             }
  30.           ]
  31.         },
  32.         {
  33.           "label": "战士",
  34.           "children": [
  35.             {
  36.               "label": "曹操",
  37.               "value": "caocao"
  38.             },
  39.             {
  40.               "label": "钟无艳",
  41.               "value": "zhongwuyan"
  42.             }
  43.           ]
  44.         },
  45.         {
  46.           "label": "打野",
  47.           "children": [
  48.             {
  49.               "label": "李白",
  50.               "value": "libai"
  51.             },
  52.             {
  53.               "label": "韩信",
  54.               "value": "hanxin"
  55.             },
  56.             {
  57.               "label": "云中君",
  58.               "value": "yunzhongjun"
  59.             }
  60.           ]
  61.         }
  62.       ],
  63.       "options": [
  64.         {
  65.           "ref": "zhugeliang",
  66.           "children": [
  67.             {
  68.               "label": "A",
  69.               "value": "a"
  70.             }
  71.           ]
  72.         },
  73.         {
  74.           "ref": "caocao",
  75.           "children": [
  76.             {
  77.               "label": "B",
  78.               "value": "b"
  79.             },
  81.             {
  82.               "label": "C",
  83.               "value": "c"
  84.             }
  85.           ]
  86.         },
  87.         {
  88.           "ref": "zhongwuyan",
  89.           "children": [
  90.             {
  91.               "label": "D",
  92.               "value": "d"
  93.             },
  95.             {
  96.               "label": "E",
  97.               "value": "e"
  98.             }
  99.           ]
  100.         },
  101.         {
  102.           "ref": "libai",
  103.           "defer": true
  104.         },
  105.         {
  106.           "ref": "hanxin",
  107.           "defer": true
  108.         },
  109.         {
  110.           "ref": "yunzhongjun",
  111.           "defer": true
  112.         }
  113.       ]
  114.     }
  115.   ]
  116. }

多选

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “关联选择模式”, “type”: “select”, “name”: “b”, “multiple”: true, “sortable”: true, “searchable”: true, “deferApi”: “/api/mock2/form/deferOptions?label=${label}”, “selectMode”: “associated”, “leftMode”: “tree”, “leftOptions”: [ { “label”: “法师”, “children”: [ { “label”: “诸葛亮”, “value”: “zhugeliang” } ] }, { “label”: “战士”, “children”: [ { “label”: “曹操”, “value”: “caocao” }, { “label”: “钟无艳”, “value”: “zhongwuyan” } ] }, { “label”: “打野”, “children”: [ { “label”: “李白”, “value”: “libai” }, { “label”: “韩信”, “value”: “hanxin” }, { “label”: “云中君”, “value”: “yunzhongjun” } ] } ], “options”: [ { “ref”: “zhugeliang”, “children”: [ { “label”: “A”, “value”: “a” } ] }, { “ref”: “caocao”, “children”: [ { “label”: “B”, “value”: “b” },

  1.         {
  2.           "label": "C",
  3.           "value": "c"
  4.         }
  5.       ]
  6.     },
  7.     {
  8.       "ref": "zhongwuyan",
  9.       "children": [
  10.         {
  11.           "label": "D",
  12.           "value": "d"
  13.         },
  15.         {
  16.           "label": "E",
  17.           "value": "e"
  18.         }
  19.       ]
  20.     },
  21.     {
  22.       "ref": "libai",
  23.       "defer": true
  24.     },
  25.     {
  26.       "ref": "hanxin",
  27.       "defer": true
  28.     },
  29.     {
  30.       "ref": "yunzhongjun",
  31.       "defer": true
  32.     }
  33.   ]
  34. }

] }

  2. leftOptions 动态加载，默认 source 接口是返回 options 部分，而 leftOptions 是没有对应的接口可以动态返回了。为了方便，目前如果 source 接口返回的选中中，第一个 option 是以下这种格式则也会把 options[0].leftOptions 当成 leftOptions, options[0].children 当 options。同时 options[0].leftDefaultValue 可以用来配置左侧选项的默认值。

{ status: 0, msg: ‘’, data: { options: [ { leftOptions: [], children: [], leftDefaultValue: ‘’ } ] } }

  2. ### 人员点选
  4. > 请通过网络面板查看接口请求返回。
  6. 实际上就是采用的[「关联选择模式」](#关联选择模式)的 select，注意要看那一部分文档，需要知道怎么动态加载 leftOptions。左侧部分和人员都是通过 source 接口返回。需要懒加载的项通过设置 `defer` 为 true 来标记。左右两部分都支持懒加载。
  7. 都是通过 deferApi 来实现，后端根据传过来的参数决定是懒加载树，还是栏加载人员。
  9. - 有 dep 值则是懒加载部门树
  10. - 有 ref 值则是懒加载人员
  12. ```schema: scope="body"
  13. {
  14.   "type": "form",
  15.   "api": "/api/mock2/form/saveForm",
  16.   "body": [
  17.     {
  18.       "label": "人员选择",
  19.       "type": "select",
  20.       "name": "b",
  21.       "multiple": true,
  22.       "sortable": true,
  23.       "searchable": true,
  24.       "selectMode": "associated",
  25.       "leftMode": "tree",
  26.       "source": "/api/mock2/form/departUser",
  27.       "deferApi": "/api/mock2/form/departUser?ref=${ref}&dep=${value}"
  28.     }
  29.   ]
  30. }

限制标签最大展示数量

1.10.0 及以上版本

maxTagCount可以限制标签的最大展示数量，超出数量的部分会收纳到 Popover 中，可以通过overflowTagPopover配置 Popover 相关的属性，注意该属性仅在多选模式开启后生效。

```schema: scope=”body” { “type”: “form”, “api”: “/api/mock2/form/saveForm”, “body”: [ { “label”: “水果”, “type”: “select”, “name”: “select”, “multiple”: true, “maxTagCount”: 3, “checkAll”: true, “defaultCheckAll”: true, “overflowTagPopover”: { “title”: “水果” }, “options”: [ {“label”: “苹果”, “value”: “Apple”}, {“label”: “香蕉”, “value”: “Banana”}, {“label”: “黑莓”, “value”: “Blackberry”}, {“label”: “蓝莓”, “value”: “Blueberry”}, {“label”: “樱桃”, “value”: “Cherry”}, {“label”: “杨桃”, “value”: “Carambola”}, {“label”: “椰子”, “value”: “Coconut”}, {“label”: “猕猴桃”, “value”: “Kiwifruit”}, {“label”: “柠檬”, “value”: “Lemon”}, {“label”: “菠萝”, “value”: “Pineapple”} ] } ] }

  2. ## searchApi
  4. **发送**
  6. 默认 GET，携带 term 变量，值为搜索框输入的文字，可从上下文中取数据设置进去。
  8. **响应**
  10. 格式要求如下：
  12. ```json
  13. {
  14.   "status": 0,
  15.   "msg": "",
  16.   "data": {
  17.     "options": [
  18.       {
  19.         "label": "描述",
  20.         "value": "值" // ,
  21.         // "children": [] // 可以嵌套
  22.       },
  24.       {
  25.         "label": "描述2",
  26.         "value": "值2"
  27.       }
  28.     ],
  30.     "value": "值" // 默认值，可以获取列表的同时设置默认值。
  31.   }
  32. }

适用于需选择的数据/信息源较多时，用户可直观的知道自己所选择的数据/信息的场景，一般左侧框为数据/信息源，右侧为已选数据/信息，被选中信息同时存在于 2 个框内。

属性表

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

属性名 类型 默认值 说明
options Array<object>或Array<string> 选项组
source API 或 数据映射 动态选项组
autoComplete API 自动提示补全
delimiter string false 拼接符
labelField string "label" 选项标签字段
valueField string "value" 选项值字段
joinValues boolean true 拼接值
extractValue boolean false 提取值
checkAll boolean false 是否支持全选
checkAllLabel string 全选 全选的文字
checkAllBySearch boolean false 有检索时只全选检索命中的项
defaultCheckAll boolean false 默认是否全选
creatable boolean false 新增选项
multiple boolean false 多选
searchable boolean false 检索
createBtnLabel string "新增选项" 新增选项
addControls Array<表单项> 自定义新增表单项
addApi API 配置新增选项接口
editable boolean false 编辑选项
editControls Array<表单项> 自定义编辑表单项
editApi API 配置编辑选项接口
removable boolean false 删除选项
deleteApi API 配置删除选项接口
autoFill object 自动填充
menuTpl string 支持配置自定义菜单
clearable boolean 单选模式下是否支持清空
hideSelected boolean false 隐藏已选选项
mobileClassName string 移动端浮层类名
selectMode string `` 可选：group、table、tree、chained、associated。分别为：列表形式、表格形式、树形选择形式、级联选择形式，关联选择形式（与级联选择的区别在于，级联是无限极，而关联只有一级，关联左边可以是个 tree）。
searchResultMode string 如果不设置将采用 selectMode 的值，可以单独配置，参考 selectMode，决定搜索结果的展示形式。
columns Array<Object> 当展示形式为 table 可以用来配置展示哪些列，跟 table 中的 columns 配置相似，只是只有展示功能。
leftOptions Array<Object> 当展示形式为 associated 时用来配置左边的选项集。
leftMode string 当展示形式为 associated 时用来配置左边的选择形式，支持 list 或者 tree。默认为 list。
rightMode string 当展示形式为 associated 时用来配置右边的选择形式，可选：list、table、tree、chained。
maxTagCount number 标签的最大展示数量，超出数量后以收纳浮层的方式展示，仅在多选模式开启后生效
overflowTagPopover TooltipObject {"placement": "top", "trigger": "hover", "showArrow": false, "offset": [0, -10]} 收纳浮层的配置属性，详细配置参考Tooltip
optionClassName string 选项 CSS 类名

事件表

当前组件会对外派发以下事件，可以通过onEvent来监听这些事件，并通过actions来配置执行的动作，在actions中可以通过event.data.xxx事件参数变量来获取事件产生的数据，详细请查看事件动作。

事件名称 事件参数 说明
change event.data.value: string 选中值 选中值变化时触发
blur event.data.value: string 选中值 输入框失去焦点时触发
focus event.data.value: string 选中值 输入框获取焦点时触发
add event.data.options: Option[] 选项集合
event.data.value: Option 新增的选项		 新增选项提交时触发
edit event.data.options: Option[] 选项集合
event.data.value: Option 编辑的选项		 编辑选项提交时触发
delete event.data.options: Option[] 选项集合
event.data.value: Option 删除的选项		 删除选项提交时触发

动作表

当前组件对外暴露以下特性动作，其他组件可以通过指定actionType: 动作名称、componentId: 该组件id来触发这些动作，动作配置可以通过args: {动作配置项名称: xxx}来配置具体的参数，详细请查看事件动作。

动作名称 动作配置 说明
clear - 清空
reset - 将值重置为resetValue，若没有配置resetValue，则清空
reload - 重新加载，调用 source，刷新数据域数据刷新（重新加载）
setValue value: string 更新的值 更新数据，开启multiple，多值用,分隔