tree-transfer树形穿梭框的使用
2021-02-01 本文已影响0人
陶菇凉
首先
npm install el-tree-transfer --save或者npm i el-tree-transfer -S安装
效果图
image.png
<template>
<div>
// 你的代码
...
// 使用树形穿梭框组件
<tree-transfer :title="title" :from_data='fromData' :to_data='toData' :defaultProps="{label:'label'}" @add-btn='add' @remove-btn='remove' :mode='mode' height='540px' filter openAll>
</tree-transfer>
</div>
</template>
<script>
import treeTransfer from 'el-tree-transfer' // 引入
export defult {
data(){
return:{
mode: "transfer", // transfer addressList
fromData:[
{
id: "1",
pid: 0,
label: "一级 1",
children: [
{
id: "1-1",
pid: "1",
label: "二级 1-1",
disabled: true,
children: []
},
{
id: "1-2",
pid: "1",
label: "二级 1-2",
children: [
{
id: "1-2-1",
pid: "1-2",
children: [],
label: "二级 1-2-1"
},
{
id: "1-2-2",
pid: "1-2",
children: [],
label: "二级 1-2-2"
}
]
}
]
},
],
toData:[]
}
},
methods:{
// 切换模式 现有树形穿梭框模式transfer 和通讯录模式addressList
changeMode() {
if (this.mode == "transfer") {
this.mode = "addressList";
} else {
this.mode = "transfer";
}
},
// 监听穿梭框组件添加
add(fromData,toData,obj){
// 树形穿梭框模式transfer时,返回参数为左侧树移动后数据、右侧树移动后数据、移动的{keys,nodes,halfKeys,halfNodes}对象
// 通讯录模式addressList时,返回参数为右侧收件人列表、右侧抄送人列表、右侧密送人列表
console.log("fromData:", fromData);
console.log("toData:", toData);
console.log("obj:", obj);
},
// 监听穿梭框组件移除
remove(fromData,toData,obj){
// 树形穿梭框模式transfer时,返回参数为左侧树移动后数据、右侧树移动后数据、移动的{keys,nodes,halfKeys,halfNodes}对象
// 通讯录模式addressList时,返回参数为右侧收件人列表、右侧抄送人列表、右侧密送人列表
console.log("fromData:", fromData);
console.log("toData:", toData);
console.log("obj:", obj);
}
},
components:{ treeTransfer } // 注册
}
</script>
<style>
...
</style>
注意:数据的pid一定要存在
文档
*序号 | 参数 | 说明 | 类型 | 默认值 | 补充 |
---|---|---|---|---|---|
*1 | width | 宽度 | String | 100% | 建议在外部盒子设定宽度和位置,否则100%不会生效 |
*2 | height | 高度 | String | 300px | - |
*3 | title | 标题 | String | ["源列表", "目标列表"] | - |
*4 | button_text | 按钮名字 | Array | - | - |
*5 | from_data | 源数据 | Array | - | 数据格式同element-ui tree组件,但必须有id和pid |
*6 | to_data | 目标数据 | Array | - | 数据格式同element-ui tree组件,但必须有id和pid |
*7 | defaultProps | 配置项-同el-tree中props | Object | { label: "label", children: "children", isLeaf: "leaf", disable: "disable" } | 用法和el-tree的props一样 |
*8 | node_key | 自定义node-key的值,默认为id | String | id | 必须与treedata数据内的id参数名一致,必须唯一 |
*9 | pid | 自定义pid的参数名,默认为"pid" | String | pid | 有网友提出后台给的字段名不叫pid,因此增加自定义支持 |
*10 | filter | 是否开启筛选功能 | Boolean | false | 根据defaultProps参数的label字段筛选 |
*12 | openAll | 是否默认展开全部 | Boolean | false | 存在性能问题 |
*13 | defaultCheckedKeys | 默认选中节点 | Array | false | 只匹配初始时默认节点,不会在你操作后动态改变默认节点 |
方法
*序号 | 名称 | 说明 |
---|---|---|
*0 | addToAims | 手动调用添加穿梭,用于调整初始数据默认穿梭 function(useCallBack: Boolean) 本次穿梭是否需要触发@add-btn的emit回调 |
*1 | clearChecked | 清除选中节点,默认清除全部 function(type: String) left左边 right右边 all全部 默认all |
*2 | getChecked | 获取选中数据,若使用了to_data,可以直接用 |
*3 | setChecked | 设置选中数据 function(leftKeys = [], rightKeys = []) |
*4 | clearFilter | 清除搜索框条件,默认清除全部 function(type: String) left左边 right右边 all全部 默认all |