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 router2.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穿梭框的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 017_Upload上传
- 下一篇: 021_Form表单