el-transfer 穿梭框组件就是左右各有一个复选框列表,可以将左侧选中的项目移动到右边,后者将右侧的选中项移回左边的控件。一般用于授权、成员分配、物品交换等场景,本文从基本使用入手,详细介绍 el-transfer 穿梭框在常见场景下的使用方法。
1、穿梭框组件介绍
1.1 穿梭框组件样例
组件代码:
<el-transfer v-model="value" :data="preData" @change="selectChange"></el-transfer>
组件绑定的值:
preData: [{
key: 1,
label: '北京',
disabled: false
},
{
key: 2,
label: '上海',
disabled: false
},
{
key: 3,
label: '广州',
disabled: true
}],
value: [],
组件绑定的方法:
methods: {
selectChange(value) {
console.log(value);
}
}
从示例代码可以看到,Transfer 的数据通过 data 属性传入。数据需要是一个对象数组(preData),其中的每个对象均有以下属性:
- key 为数据的唯一性标识。
- label 为显示文本(显示到穿梭框中的值)。
- disabled 表示该项数据是否禁止转移(disabled为true时表示禁用,此时该数据项为灰色无法移动)。
value属性是选中项key的数组,当数据项被移动到右侧时,其key值被加入value数组中。如果希望在初始状态时目标列表不为空,可以为 v-model 绑定的变量赋予一个初始值。
@change表示选中项发生变化时触发的方法。
1.2 穿梭框组件的 Attributes属性
参数 | 说明 | 类型 | 可选值 | 默认值 |
---|---|---|---|---|
value / v-model | 绑定值 | array | — | — |
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: ‘{total}’, hasChecked: ‘{total}’ } |
props | 数据源的字段别名 | object | — | — |
left-default-checked | 初始状态下左侧列表的已勾选项的 key 数组 | array | — | [ ] |
right-default-checked | 初始状态下右侧列表的已勾选项的 key 数组 | array | — | [ ] |
1.3 穿梭框组件的 Slot
name | 说明 |
---|---|
left-footer | 左侧列表底部的内容 |
right-footer | 右侧列表底部的内容 |
1.4 穿梭框组件的 Scoped Slot
name | 说明 |
---|---|
— | 自定义数据项的内容,参数为 |
1.5 穿梭框组件的 Methods
方法名 | 说明 | 参数 |
---|---|---|
clearQuery | 清空某个面板的搜索关键词 | ‘left’ / ‘right’,指定需要清空的面板 |
1.6 穿梭框组件的 Events
事件名称 | 说明 | 回调参数 |
---|---|---|
change | 右侧列表元素变化时触发 | 当前值、数据移动的方向(‘left’ / ‘right’)、发生移动的数据 key 数组 |
left-check-change | 左侧列表元素被用户选中 / 取消选中时触发 | 当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组 |
right-check-change | 右侧列表元素被用户选中 / 取消选中时触发 | 当前被选中的元素的 key 数组、选中状态发生变化的元素的 key 数组 |
2、基本用法
Transfer 的数据通过 data 属性传入。数据需要是一个对象数组,每个对象有以下属性:key 为数据的唯一性标识,label 为显示文本,disabled 表示该项数据是否禁止转移。目标列表中的数据项会同步到绑定至 v-model 的变量,值为数据项的 key 所组成的数组。
基本用法示例如下:
<template>
<el-transfer v-model="value" :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(),
value: [1, 4]
};
}
};
</script>
2、可搜索穿梭框
在数据很多的情况下,可以对数据进行搜索和过滤。设置 filterable 为 true 即可开启搜索模式。默认情况下,若数据项的 label 属性包含搜索关键字,则会在搜索结果中显示。
- 还可以使用 filter-method 定义自己的搜索逻辑。filter-method 接收一个方法,当搜索关键字变化时,会将当前的关键字和每个数据项传给该方法。若方法返回 true,则会在搜索结果中显示对应的数据项。
可搜索穿梭框示例如下:
<template>
<el-transfer
filterable
:filter-method="filterMethod"
filter-placeholder="请输入城市拼音"
v-model="value"
:data="data">
</el-transfer>
</template>
<script>
export default {
data() {
const generateData = _ => {
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 {
data: generateData(),
value: [],
filterMethod(query, item) {
return item.pinyin.indexOf(query) > -1;
}
};
}
};
</script>
3、可自定义穿梭框
可以对列表标题文案、按钮文案、数据项的渲染函数、列表底部的勾选状态文案、列表底部的内容区等进行自定义。
- 可以使用 titles、button-texts、render-content 和 format 属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。
- 数据项的渲染还可以使用 scoped-slot 进行自定义。对于列表底部的内容区,提供了两个具名 slot:left-footer 和 right-footer。此外,如果希望某些数据项在初始化时就被勾选,可以使用 left-default-checked 和 right-default-checked 属性。
- 本例展示了 change 事件的用法 @change=“handleChange” 。
- 注意:由于 jsfiddle 不支持 JSX 语法,所以使用 render-content 自定义数据项的例子在 jsfiddle 中无法运行。但是在实际的项目中,只要正确地配置了相关依赖,就可以正常运行。
可自定义穿梭框示例如下:
<template>
<p style="text-align: center; margin: 0 0 20px">使用 render-content 自定义数据项</p>
<div style="text-align: center">
<el-transfer
style="text-align: left; display: inline-block"
v-model="value"
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>
</div>
<p style="text-align: center; margin: 50px 0 20px">使用 scoped-slot 自定义数据项</p>
<div style="text-align: center">
<el-transfer
style="text-align: left; display: inline-block"
v-model="value4"
filterable
:left-default-checked="[2, 3]"
:right-default-checked="[1]"
:titles="['Source', 'Target']"
:button-texts="['到左边', '到右边']"
:format="{
noChecked: '${total}',
hasChecked: '${checked}/${total}'
}"
@change="handleChange"
:data="data">
<span slot-scope="{ option }">{{ option.key }} - {{ option.label }}</span>
<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>
</div>
</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(),
value: [1],
value4: [1],
renderFunc(h, option) {
return <span>{ option.key } - { option.label }</span>;
}
};
},
methods: {
handleChange(value, direction, movedKeys) {
console.log(value, direction, movedKeys);
}
}
};
</script>
4、数据项属性别名
默认情况下,Transfer 仅能识别数据项中的 key、label 和 disabled 字段。如果你的数据的字段名不同,可以使用 props 属性为它们设置别名。
- 本例中的数据源没有 key 和 label 字段,在功能上与它们相同的字段名为 value 和 desc。因此可以使用props 属性为 key 和 label 设置别名。
数据项属性别名示例如下:
<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>
5、左右列表分页穿梭框
在数据很多的情况下,可以对数据进行分页展示。
<template>
<el-transfer
style="text-align: left; display: inline-block"
v-model="value"
filterable
:titles="['已关联', '未关联']"
:button-texts="['绑定', '解绑']"
@change="handleChange"
:data="data"
>
<!-- 右侧栏分页 -->
<el-button
type="text"
style="color:#606266"
v-if="value.length != 0"
class="transfer-footer"
slot="right-footer"
size="small"
>共{{ Rtotal }}条</el-button>
<el-button
v-if="value.length != 0"
class="transfer-footer"
slot="right-footer"
size="small"
@click="rightPageNumChange"
:disabled="RPageNum - 1 < 1"
>上一页</el-button>
<el-input
v-if="value.length != 0"
v-model="RPageNum"
size="mini"
class="transfer-footer"
slot="right-footer"
:placeholder="RPageNum"
style="width: 43px"
></el-input>
<el-button
class="transfer-footer"
slot="right-footer"
size="small"
@click="rightAddPageNumChange"
v-if="value.length != 0"
:disabled="RPageNum > nextPage"
>下一页</el-button>
<!-- 左侧栏分页 -->
<el-button
type="text"
style="color:#606266"
v-if="leftLength != 0"
class="transfer-footer"
slot="left-footer"
size="small"
>共{{ Ltotal }}条</el-button>
<el-button
v-if="leftLength != 0"
class="transfer-footer"
slot="left-footer"
size="small"
@click="leftPageNumChange"
:disabled="LPageNum - 1 < 1"
>上一页</el-button>
<el-input
v-if="leftLength != 0"
v-model="LPageNum"
size="mini"
class="transfer-footer"
slot="left-footer"
:placeholder="LPageNum"
style="width: 43px"
></el-input>
<el-button
class="transfer-footer"
slot="left-footer"
size="small"
@click="leftAddPageNumChange"
v-if="leftLength != 0"
:disabled="LPageNum > LNextPage"
>下一页</el-button>
</el-transfer>
</template>
<script>
import {
listUsersByUser,
listUsersNotInUser,
distUser,
removeDistUser
} from "@/api/user";
export default {
data () {
return {
// 穿梭框数据,这里注意,里面的属性名要和element里面的一样 不能自定义
data: [{ key: 3, label: "你好", pinyin: "lalla" }, { key: 4, label: "很nice", pinyin: "aaa" }], //存放所有的数据,除了value的都是左侧的
value: [3], //存放右侧菜单数据,里面的数值和data中的key值一致
// 右侧分页数据
Rtotal: "",
RPageNum: "1",
RPageSize: "20",
nextPage: null,
// 左侧分页数据
Ltotal: "",
LPageNum: "1",
LPageSize: "20",
LNextPage: null,
leftLength: null
};
methods:{
// 穿梭框更改事件
async handleChange (value, direction, keyArr) {
let followsArr = []
//value为左/右的所有数值,direction为方向left or right,keyArr为选中的key
switch (direction) {
//右到左 绑定
case 'left':
// 调用后端api绑定接口
break
//从左到右 解绑
case 'right':
// 调用后端api解绑接口
break
}
}
}
}
</script>
6、穿梭框高度及tips提示
在数据项内容较多的时候,有时需要设置内部框的高度,以及给鼠标经过的选项值加一个title的tips提示。
<template>
<el-transfer v-model="transferValue" ref="transfer" :data="dataList"
@mouseover.native="addTitle"
:titles="['备选列表', '已选列表']">
</el-transfer>
</template>
<script>
export default {
data() {
// 省略
...
},
methods: {
//手动给鼠标划过穿梭框的元素添加一个title
addTitle(e) {
let target_el = e.target;
if (target_el.title) return;
target_el.title = target_el.innerText;
},
},
}
</script>
<style>
.el-transfer-panel {
width: 300px;
}
.el-transfer-panel__body {
weight: 300px;
height: 400px;
}
.el-transfer-panel__list {
weight: 300px;
height: 400px;
}
</style>
评论区