020_Transfer穿梭框

1. Transfer穿梭框

1.1. 属性

参数	说明	类型	可选值	默认值
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, hasChecked}	无	{ noChecked: '${checked}/${total}', hasChecked: '${checked}/${total}' }
props	数据源的字段别名	object{key, label, disabled}	无	无
left-default-checked	初始状态下左侧列表的已勾选项的key数组	array	无	[ ]
right-default-checked	初始状态下右侧列表的已勾选项的key数组	array	无	[ ]

1.2. Slot

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

1.3. Scoped Slot

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

1.4. 方法

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

1.5. 事件

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

2. Transfer穿梭框例子

2.1. 使用脚手架新建一个名为element-ui-transfer的前端项目, 同时安装Element插件。

2.2. 编写index.js 

import Vue from 'vue' import VueRouter from 'vue-router' import Transfer from '../components/Transfer.vue' import FilterTransfer from '../components/FilterTransfer.vue' import MyTransfer from '../components/MyTransfer.vue' import AliasTransfer from '../components/AliasTransfer.vue'Vue.use(VueRouter)const routes = [{ path: '/', redirect: '/Transfer' },{ path: '/Transfer', component: Transfer },{ path: '/FilterTransfer', component: FilterTransfer },{ path: '/MyTransfer', component: MyTransfer },{ path: '/AliasTransfer', component: AliasTransfer } ]const router = new VueRouter({routes })export default router

2.3. 在components在新建Transfer.vue

<template><div><h1>基础用法</h1><h4>Transfer的数据通过data属性传入。数据需要是一个对象数组, 每个对象有以下属性: key为数据的唯一性标识, label为显示文本, disabled表示该项数据是否禁止转移。目标列表中的数据项会同步到绑定至v-model的变量, 值为数据项的key所组成的数组。当然, 如果希望在初始状态时目标列表不为空, 可以像本例一样为v-model绑定的变量赋予一个初始值。</h4><el-transfer v-model="value" :data="data"></el-transfer></div> </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.4. 在components在新建FilterTransfer.vue

<template><div><h1>可搜索-在数据很多的情况下, 可以对数据进行搜索和过滤</h1><h4>设置filterable为true即可开启搜索模式。默认情况下, 若数据项的label属性包含搜索关键字, 则会在搜索结果中显示。你也可以使用filter-method定义自己的搜索逻辑。filter-method接收一个方法, 当搜索关键字变化时, 会将当前的关键字和每个数据项传给该方法。若方法返回true, 则会在搜索结果中显示对应的数据项。</h4><el-transfer filterable :filter-method="filterMethod" filter-placeholder="请输入城市拼音" v-model="value" :data="data"></el-transfer></div> </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>

2.5. 在components在新建MyTransfer.vue

<template><div><h1>可自定义</h1><h4>可以使用titles、button-texts、render-content和format属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。数据项的渲染还可以使用scoped-slot进行自定义。对于列表底部的内容区, 提供了两个具名slot: left-footer和right-footer。此外, 如果希望某些数据项在初始化时就被勾选, 可以使用left-default-checked和right-default-checked属性。</h4><p>使用render-content自定义数据项</p><div><el-transfer v-model="value1" filterable :left-default-checked="[2, 3]" :right-default-checked="[1]" :render-content="renderFunc":format="{noChecked: '${total}',hasChecked: '${checked}/${total}'}":titles="['Source', 'Target']" :button-texts="['到左边', '到右边']" @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>使用scoped-slot自定义数据项</p><div><el-transfer v-model="value2" filterable :left-default-checked="[2, 3]" :right-default-checked="[1]" :titles="['Source', 'Target']":format="{noChecked: '${total}',hasChecked: '${checked}/${total}'}":button-texts="['到左边', '到右边']" @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></div> </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],value2: [1],renderFunc (h, option) {console.log(h)return <span>{ option.key } - { option.label }</span>}}},methods: {handleChange (value, direction, movedKeys) {console.log(value, direction, movedKeys)}} } </script><style scoped>.el-transfer .transfer-footer {margin-left: 20px;padding: 6px 5px;} </style>

2.6. 在components在新建AliasTransfer.vue

<template><div><h1>数据项属性别名</h1><h4>默认情况下, Transfer仅能识别数据项中的key、label和disabled字段。如果你的数据的字段名不同, 可以使用props属性为它们设置别名。</h4><el-transfer v-model="value" :props="{ key: 'value', label: 'desc' }" :data="data"></el-transfer></div> </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>

2.7. 访问http://localhost:8080/#/Transfer

2.8. 访问http://localhost:8080/#/FilterTransfer 

2.9. 访问http://localhost:8080/#/MyTransfer 

2.10. 访问http://localhost:8080/#/AliasTransfer 

总结

以上是生活随笔为你收集整理的020_Transfer穿梭框的全部内容，希望文章能够帮你解决所遇到的问题。

如果觉得生活随笔网站内容还不错，欢迎将生活随笔推荐给好友。