一个基于vue和element-ui的树形穿梭框组件

el-tree-transfer

因业务需求需要用到一个穿梭框组件,而各大主流UI库和市面上的穿梭框都是一维数据,不支持树形结构的穿梭数据,

然后我自己就写了一个树形穿梭框组件,用户界面完全按照元素的UI风格。并且使用此插件时默认你已经引入了元素的用户界面的按钮,复选框,树组件!并且是一个VUE项目,你就可以像使用普通VUE组件一样使用它。

el-tree-fransfer

简介

el-tree-fransfer是一个基于VUE和element-ui的树形穿梭框组件,使用前请确认已经引入元素-ui!此组件功能类似于element-ui的转移组件,但是里面的数据是树形结构!实际上,el-tree-transfer依赖的element-ui组件分别是Checkbox多选框Button按钮,和最主要的Tree树形控件写成!并非是在element-ui的穿梭框组件上的扩展,而仅仅是参照了其外观样式和功能。

因为公司业务使用VUE框架,UI库使用的元素的用户界面。在市面上找到一个好用的VUE树形穿梭框组件都很难,又不想仅仅因为一个穿梭框在元件的UI之外引入其他重量级插件,因此就有了EL-树转移。轻量,易用,无需投入其他学习成本。

在线访问

注意! 1.7.7版本移动事件参数调整,直接返回移动后的fromData数据和toData数据。

注意! (1.5版本以上会自动处理)

第一层数据的 pid 请设定为 0!!

id推荐为string,但也可以是number,请不要混用,id不能重复!

快速上手

先NPM下载插件

npm install el-tree-transfer --save

npm i el-tree-transfer -S

然后你可以像使用普通组件一样使用el-tree-transfer 

// 你的代码 ... // 使用树形穿梭框组件
import treeTransfer from 'el-tree-transfer' // 引入 export defult { data(){ return:{ fromData:[ { id: "1", pid: 0, label: "一级 1", children: [ { id: "1-1", pid: "1", label: "二级 1-1", 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:{ // 监听穿梭框组件添加 add(fromData,toData,obj){ conlose.log('fromData',fromData); conlose.log('toData',toData); conlose.log('obj',obj); }, // 监听穿梭框组件移除 remove(fromData,toData,obj){ conlose.log('fromData',fromData); conlose.log('toData',toData); conlose.log('obj',obj); } }, comporents:{ treeTransfer } // 注册 } ...

...

文档

1. 参数:`width` 说明:`宽度` 类型:`String` 必填:`false` 默认:`100%` 补充:`建议在外部盒子设定宽度和位置`

2.  参数:`height` 说明:`高度` 类型:`String` 必填:`false` 默认:`320px`

3.  参数:`title` 说明:`标题` 类型:`Array` 必填:`false` 默认:`["源列表", "目标列表"]`

4.  参数:`button_text` 说明:`按钮名字` 类型:`Array` 必填:`false` 默认:`空`

5.  参数:`from_data` 说明:`源数据` 类型:`Array` 必填:`true` 补充:`数据格式同element-ui tree组件,但必须有id和pid`

6.  参数:`to_data` 说明:`目标数据` 类型:`Array` 必填:`true` 补充:`数据格式同element-ui tree组件,但必须有id和pid`

7.  参数:`defaultProps` 说明:`配置项-同el-tree中props` 必填: `false` 补充:`用法和el-tree的props一样`

8.  参数:`node_key` 说明:`自定义node-key的值,默认为id` 必填:`false` 补充:`必须与treedata数据内的id参数名一致,必须唯一`

9.  参数:`pid` 说明:`自定义pid的参数名,默认为"pid"` 必填:`false` 补充:`有网友提出后台给的字段名不叫pid,因此增加自定义支持`

10. 参数:`leafOnly` 说明:`是否只返回叶子节点` 类型:`Boolean` 必填:`false` 补充:`默认false,如果你只需要返回的末端子节点可使用此参数`

11. 参数:`filter` 说明:`是否开启筛选功能` 类型:`Boolean` 必填:`false`

12. 参数:`openAll` 说明:`是否默认展开全部` 类型:`Boolean` 必填:`false`

13. 参数:`renderContent` 说明:`自定义树节点` 类型:`Function` 必填:`false` 补充:`用法同element-ui tree`

14. 事件:`addBtn` 说明:`点击添加按钮时触发的事件` 回调参数:`keys:data为选中节点id,nodes:data为选中节点`

15. 事件:`removeBtn` 说明:`点击移除按钮时触发的事件` 回调参数:`keys:data为选中节点id,nodes:data为选中节点`

版本说明

1.7.7 版本 `addBtn` 和 `removeBtn` 事件参数调整,返回三个参数,第一个参数是移动后的fromData数据,第二个参数是移动后的toData数据,第三个参数是{keys, nodes, harfKeys, harfNodes}对象。增加 `renderContent` 参数支持树节点自定义。

1.6.7 版本增加`filter,openAll`参数,来设置是否开启筛选和是否默认展开全部

1.5.9版本增加`leafOnly`参数,来设置是否只返回树的末端叶子节点

1.5.8版本恢复上个版本莫名删掉的返回` nodes `的代码,如果您的项目只需要穿梭的node-key值则无需更新!道歉ing。。。

1.5.7版本修复子组件异步数据有时不会更新的问题!修复了自定义参数名node_key,children时的一个错误,自动把第一层数据的pid替换为0

1.4.9版本增加了添加和移除按钮的回调参数,function(keys,nodes)第一个参数为选中节点node-key值,第二个参数为选中节点node

1.4.8 版本修复了id为number类型时无法通过重复校验函数的问题,但仍然推荐id使用string型

1.4.7增加版本了defaultProps参数,node_key参数,pid参数,主要作用为可以自定义一些重要字段名,来提高数据灵活性,避免和后台因为字段名不同而被祭天

1.3.7版本取消了对loadsh库的依赖,此前仅用此库做某些深拷贝处理

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350