Transfer 穿梭框

基礎用法

Transfer 的數據通過 data 屬性傳入。數據需要是一個對象數組，每個對象有以下屬性：key 為數據的唯一性標識，label為顯示文本，disabled 表示該項數據是否禁止轉移。目標列表中的數據項會同步到綁定至 v-model 的變量，值為數據項的 key 所組成的數組。當然，如果希望在初始狀態時目標列表不為空，可以像本例一樣為 v-model 綁定的變量賦予一個初始值。

<template>
  <el-transfer v-model="value1" :data="data"></el-transfer>
</template>

<script>
  export default {
    data() {
      const generateData = _ => {
        const data = [];
        for (let i = 1; i <= 15; i++) {
          data.push({
            key: i,
            label: `備選項 ${ i }`,
            disabled: i % 4 === 0
          });
        }
        return data;
      };
      return {
        data: generateData(),
        value1: [1, 4]
      };
    }
  };
</script>

可搜索

在數據很多的情況下，可以對數據進行搜索和過濾。

設置 filterable 為 true 即可開啟搜索模式。默認情況下，若數據項的 label 屬性包含搜索關鍵字，則會在搜索結果中顯示。你也可以使用 filter-method 定義自己的搜索邏輯。filter-method 接收一個方法，當搜索關鍵字變化時，會將當前的關鍵字和每個數據項傳給該方法。若方法返回 true，則會在搜索結果中顯示對應的數據項。

<template>
  <el-transfer
    filterable
    :filter-method="filterMethod"
    filter-placeholder="請輸入城市拼音"
    v-model="value2"
    :data="data2">
  </el-transfer>
</template>

<script>
  export default {
    data() {
      const generateData2 = _ => {
        const data = [];
        const cities = ['上海', '北京', '廣州', '深圳', '南京', '西安', '成都'];
        const pinyin = ['shanghai', 'beijing', 'guangzhou', 'shenzhen', 'nanjing', 'xian', 'chengdu'];
        cities.forEach((city, index) => {
          data.push({
            label: city,
            key: index,
            pinyin: pinyin[index]
          });
        });
        return data;
      };
      return {
        data2: generateData2(),
        value2: [],
        filterMethod(query, item) {
          return item.pinyin.indexOf(query) > -1;
        }
      };
    }
  };
</script>

可自定義

可以對列表標題文案、按鈕文案、數據項的渲染函數、列表底部的勾選狀態文案、列表底部的內容區等進行自定義。

可以使用 titles、button-texts、render-content 和 format 屬性分別對列表標題文案、按鈕文案、數據項的渲染函數和列表頂部的勾選狀態文案進行自定義。對於列表底部的內容區，提供了兩個具名 slot：left-footer 和 right-footer。此外，如果希望某些數據項在初始化時就被勾選，可以使用 left-default-checked 和 right-default-checked 屬性。最后，本例還展示了 change 事件的用法。注意：由於 jsfiddle 不支持 JSX 語法，所以本例在 jsfiddle 中無法運行。但是在實際的項目中，只要正確地配置了相關依賴，就可以正常運行。

<template>
  <el-transfer
    v-model="value3"
    filterable
    :left-default-checked="[2, 3]"
    :right-default-checked="[1]"
    :render-content="renderFunc"
    :titles="['Source', 'Target']"
    :button-texts="['到左邊', '到右邊']"
    :format="{
      noChecked: '${total}',
      hasChecked: '${checked}/${total}'
    }"
    @change="handleChange"
    :data="data">
    <el-button class="transfer-footer" slot="left-footer" size="small">操作</el-button>
    <el-button class="transfer-footer" slot="right-footer" size="small">操作</el-button>
  </el-transfer>
</template>

<style>
  .transfer-footer {
    margin-left: 20px;
    padding: 6px 5px;
  }
</style>

<script>
  export default {
    data() {
      const generateData = _ => {
        const data = [];
        for (let i = 1; i <= 15; i++) {
          data.push({
            key: i,
            label: `備選項 ${ i }`,
            disabled: i % 4 === 0
          });
        }
        return data;
      };
      return {
        data: generateData(),
        value3: [1],
        renderFunc(h, option) {
          return <span>{ option.key } - { option.label }</span>;
        }
      };
    },

    methods: {
      handleChange(value, direction, movedKeys) {
        console.log(value, direction, movedKeys);
      }
    }
  };
</script>

數據項屬性別名

默認情況下，Transfer 僅能識別數據項中的 key、label 和 disabled 字段。如果你的數據的字段名不同，可以使用 props 屬性為它們設置別名。

本例中的數據源沒有 key 和 label 字段，在功能上與它們相同的字段名為 value 和 desc。因此可以使用props 屬性為 key 和 label 設置別名。

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

<script>
  export default {
    data() {
      const generateData3 = _ => {
        const data = [];
        for (let i = 1; i <= 15; i++) {
          data.push({
            value: i,
            desc: `備選項 ${ i }`,
            disabled: i % 4 === 0
          });
        }
        return data;
      };
      return {
        data3: generateData3(),
        value4: []
      };
    }
  };
</script>

 

Attributes

參數	說明	類型	可選值	默認值
data	Transfer 的數據源	array[{ key, label, disabled }]	—	[ ]
filterable	是否可搜索	boolean	—	false
filter-placeholder	搜索框占位符	string	—	請輸入搜索內容
filter-method	自定義搜索方法	function	—	—
target-order	右側列表元素的排序策略：若為 original，則保持與數據源相同的順序；若為 push，則新加入的元素排在最后；若為 unshift，則新加入的元素排在最前	string	original / push / unshift	original
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	右側列表底部的內容

Methods

方法名	說明	參數
clearQuery	清空某個面板的搜索關鍵詞	'left' / 'right'，指定需要清空的面板

Events

事件名稱	說明	回調參數
change	右側列表元素變化時觸發	當前值、數據移動的方向（'left' / 'right'）、發生移動的數據 key 數組