Transfer 穿梭框

基础用法

Transfer 穿梭框 - 图1

Transfer 的数据通过 data 属性传入。数据需要是一个对象数组,每个对象有以下属性:key 为数据的唯一性标识,label 为显示文本,disabled 表示该项数据是否禁止转移。目标列表中的数据项会同步到绑定至 v-model 的变量,值为数据项的 key 所组成的数组。当然,如果希望在初始状态时目标列表不为空,可以像本例一样为 v-model 绑定的变量赋予一个初始值。

  1. <template>
  2. <el-transferv-model="value" :data="data"></el-transfer>
  3. </template>
  4. <script>
  5. exportdefault{
  6. data(){
  7. const generateData = _ =>{
  8. const data =[];
  9. for(let i =1; i <=15; i++){
  10. data.push({
  11. key: i,
  12. label:`备选项 ${ i }`,
  13. disabled: i %4===0
  14. });
  15. }
  16. return data;
  17. };
  18. return{
  19. data: generateData(),
  20. value:[1,4]
  21. };
  22. }
  23. };
  24. </script>

可搜索

在数据很多的情况下,可以对数据进行搜索和过滤。

Transfer 穿梭框 - 图2

设置 filterabletrue 即可开启搜索模式。默认情况下,若数据项的 label 属性包含搜索关键字,则会在搜索结果中显示。你也可以使用 filter-method 定义自己的搜索逻辑。filter-method 接收一个方法,当搜索关键字变化时,会将当前的关键字和每个数据项传给该方法。若方法返回 true,则会在搜索结果中显示对应的数据项。

  1. <template>
  2. <el-transfer
  3. filterable
  4. :filter-method="filterMethod"
  5. filter-placeholder="请输入城市拼音"
  6. v-model="value"
  7. :data="data">
  8. </el-transfer>
  9. </template>
  10. <script>
  11. exportdefault{
  12. data(){
  13. const generateData = _ =>{
  14. const data =[];
  15. const cities =['上海','北京','广州','深圳','南京','西安','成都'];
  16. const pinyin =['shanghai','beijing','guangzhou','shenzhen','nanjing','xian','chengdu'];
  17. cities.forEach((city, index)=>{
  18. data.push({
  19. label: city,
  20. key: index,
  21. pinyin: pinyin[index]
  22. });
  23. });
  24. return data;
  25. };
  26. return{
  27. data: generateData(),
  28. value:[],
  29. filterMethod(query, item){
  30. return item.pinyin.indexOf(query)>-1;
  31. }
  32. };
  33. }
  34. };
  35. </script>

可自定义

可以对列表标题文案、按钮文案、数据项的渲染函数、列表底部的勾选状态文案、列表底部的内容区等进行自定义。

Transfer 穿梭框 - 图3

可以使用 titlesbutton-textsrender-contentformat 属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。数据项的渲染还可以使用 scoped-slot 进行自定义。对于列表底部的内容区,提供了两个具名 slot:left-footerright-footer。此外,如果希望某些数据项在初始化时就被勾选,可以使用 left-default-checkedright-default-checked 属性。最后,本例还展示了 change 事件的用法。注意:由于 jsfiddle 不支持 JSX 语法,所以使用 render-content 自定义数据项的例子在 jsfiddle 中无法运行。但是在实际的项目中,只要正确地配置了相关依赖,就可以正常运行。

  1. <template>
  2. <pstyle="text-align: center; margin:0020px">使用 render-content 自定义数据项</p>
  3. <divstyle="text-align: center">
  4. <el-transfer
  5. style="text-align: left; display:inline-block"
  6. v-model="value"
  7. filterable
  8. :left-default-checked="[2, 3]"
  9. :right-default-checked="[1]"
  10. :render-content="renderFunc"
  11. :titles="['Source', 'Target']"
  12. :button-texts="['到左边', '到右边']"
  13. :format="{
  14. noChecked: '${total}',
  15. hasChecked: '${checked}/${total}'
  16. }"
  17. @change="handleChange"
  18. :data="data">
  19. <el-buttonclass="transfer-footer"slot="left-footer"size="small">操作</el-button>
  20. <el-buttonclass="transfer-footer"slot="right-footer"size="small">操作</el-button>
  21. </el-transfer>
  22. </div>
  23. <pstyle="text-align: center; margin:50px020px">使用 scoped-slot 自定义数据项</p>
  24. <divstyle="text-align: center">
  25. <el-transfer
  26. style="text-align: left; display:inline-block"
  27. v-model="value4"
  28. filterable
  29. :left-default-checked="[2, 3]"
  30. :right-default-checked="[1]"
  31. :titles="['Source', 'Target']"
  32. :button-texts="['到左边', '到右边']"
  33. :format="{
  34. noChecked: '${total}',
  35. hasChecked: '${checked}/${total}'
  36. }"
  37. @change="handleChange"
  38. :data="data">
  39. <spanslot-scope="{ option }">{{ option.key }} - {{ option.label }}</span>
  40. <el-buttonclass="transfer-footer"slot="left-footer"size="small">操作</el-button>
  41. <el-buttonclass="transfer-footer"slot="right-footer"size="small">操作</el-button>
  42. </el-transfer>
  43. </div>
  44. </template>
  45. <style>
  46. .transfer-footer {
  47. margin-left:20px;
  48. padding:6px5px;
  49. }
  50. </style>
  51. <script>
  52. exportdefault{
  53. data(){
  54. const generateData = _ =>{
  55. const data =[];
  56. for(let i =1; i <=15; i++){
  57. data.push({
  58. key: i,
  59. label:`备选项 ${ i }`,
  60. disabled: i %4===0
  61. });
  62. }
  63. return data;
  64. };
  65. return{
  66. data: generateData(),
  67. value:[1],
  68. value4:[1],
  69. renderFunc(h, option){
  70. return<span>{ option.key }-{ option.label }</span>;
  71. }
  72. };
  73. },
  74. methods:{
  75. handleChange(value, direction, movedKeys){
  76. console.log(value, direction, movedKeys);
  77. }
  78. }
  79. };
  80. </script>

数据项属性别名

默认情况下,Transfer 仅能识别数据项中的 keylabeldisabled 字段。如果你的数据的字段名不同,可以使用 props 属性为它们设置别名。

Transfer 穿梭框 - 图4

本例中的数据源没有 keylabel 字段,在功能上与它们相同的字段名为 valuedesc。因此可以使用props 属性为 keylabel 设置别名。

<template>
  <el-transfer
    v-model="value"
    :props="{
      key: 'value',
      label: 'desc'
    }"
    :data="data">
  </el-transfer>
</template>

<script>
  export default {
    data() {
      const generateData = _ => {
        const data = [];
        for (let i = 1; i <= 15; i++) {
          data.push({
            value: i,
            desc: `备选项 ${ i }`,
            disabled: i % 4 === 0
          });
        }
        return data;
      };
      return {
        data: generateData(),
        value: []
      };
    }
  };
</script>

Attributes

参数说明类型可选值默认值
value / v-model绑定值array
dataTransfer 的数据源array[{ key, label, disabled }][ ]
filterable是否可搜索booleanfalse
filter-placeholder搜索框占位符string请输入搜索内容
filter-method自定义搜索方法function
target-order右侧列表元素的排序策略:若为 original,则保持与数据源相同的顺序;若为 push,则新加入的元素排在最后;若为 unshift,则新加入的元素排在最前stringoriginal / push / unshiftoriginal
titles自定义列表标题array['列表 1', '列表 2']
button-texts自定义按钮文案array[ ]
render-content自定义数据项渲染函数function(h, option)
format列表顶部勾选状态文案object{noChecked, hasChecked}{ noChecked: '${checked}/${total}', hasChecked: '${checked}/${total}' }
props数据源的字段别名object{key, label, disabled}
left-default-checked初始状态下左侧列表的已勾选项的 key 数组array[ ]
right-default-checked初始状态下右侧列表的已勾选项的 key 数组array[ ]

Slot

name说明
left-footer左侧列表底部的内容
right-footer右侧列表底部的内容

Scoped Slot

name说明
自定义数据项的内容,参数为 { option }

Methods

方法名说明参数
clearQuery清空某个面板的搜索关键词'left' / 'right',指定需要清空的面板

Events

事件名称说明回调参数
change右侧列表元素变化时触发当前值、数据移动的方向('left' / 'right')、发生移动的数据 key 数组
left-check-change左侧列表元素被用户选中 / 取消选中时触发当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组
right-check-change右侧列表元素被用户选中 / 取消选中时触发当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组