1.4.6

Feat: Add slot for display node/leaf name ✨

.eslintrc

@@ -0,0 +1,29 @@
+{
+  "root": true,
+  "env": {
+    "node": true
+  },
+  "extends": [
+    "plugin:vue/essential",
+    "plugin:prettier/recommended",
+    "eslint:recommended"
+  ],
+  "rules": {
+    "prettier/prettier": "error",
+    "no-console": "warn"
+  },
+  "parserOptions": {
+    "parser": "babel-eslint"
+  },
+  "overrides": [
+    {
+      "files": [
+        "**/__tests__/*.{j,t}s?(x)",
+        "**/tests/unit/**/*.spec.{j,t}s?(x)"
+      ],
+      "env": {
+        "jest": true
+      }
+    }
+  ]
+}

.huskyrc.yml

@@ -1,4 +1,3 @@
 hooks:
-  pre-commit:
+  pre-commit: npm run lint-staged
-    - npm run standard
   commit-msg: commitlint -E HUSKY_GIT_PARAMS

babel.config.js

@@ -1,5 +1,3 @@
 module.exports = {
-  presets: [
+  presets: ['@vue/cli-plugin-babel/preset']
-    '@vue/cli-plugin-babel/preset'
-  ]
 }

dev/App.vue

@@ -14,6 +14,11 @@
       default-leaf-node-name="new leaf"
       v-bind:default-expanded="false"
     >
+      <template v-slot:leafNameDisplay="slotProps">
+        <span>
+          {{ slotProps.model.name }} <span class="muted">#{{ slotProps.model.id }}</span>
+        </span>
+      </template>
       <template v-slot:addTreeNodeIcon="slotProps">
         <span class="icon">📂</span>
       </template>
@@ -31,14 +36,18 @@
       </template>
       <template v-slot:treeNodeIcon="slotProps">
         <span class="icon">
-          {{ (slotProps.model.children && slotProps.model.children.length > 0 && !slotProps.expanded) ? '🌲' : '' }}</span>
+          {{
+            slotProps.model.children && slotProps.model.children.length > 0 && !slotProps.expanded
+              ? '🌲'
+              : ''
+          }}</span
+        >
       </template>
     </vue-tree-list>
     <button @click="getNewTree">Get new tree</button>
     <pre>
       {{ newTree }}
-        </pre
+    </pre>
-    >
   </div>
 </template>
 <script>
@@ -171,4 +180,9 @@ export default {
     cursor: pointer;
   }
 }
+
+.muted {
+  color: gray;
+  font-size: 80%;
+}
 </style>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "vue-tree-list",
-  "version": "1.4.1",
+  "version": "1.4.6",
   "description": "A vue component for tree structure. Support adding treenode/leafnode, editing node's name and dragging.",
   "author": "ayou",
   "scripts": {
@@ -9,14 +9,12 @@
     "test:unit": "vue-cli-service test:unit --watch",
     "test:coverage": "vue-cli-service test:unit --coverage",
     "lint": "vue-cli-service lint",
+    "lint-staged": "lint-staged",
     "commit": "npx git-cz",
     "prepublish": "npm run build"
   },
   "main": "dist/vue-tree-list.umd.min.js",
-  "dependencies": {
+  "dependencies": {},
-    "core-js": "^3.4.3",
-    "vue": "^2.6.10"
-  },
   "devDependencies": {
     "@vue/cli-plugin-babel": "^4.1.0",
     "@vue/cli-plugin-eslint": "^4.1.0",
@@ -24,38 +22,24 @@
     "@vue/cli-service": "^4.1.0",
     "@vue/test-utils": "1.0.0-beta.29",
     "babel-eslint": "^10.0.3",
+    "core-js": "^3.4.3",
     "eslint": "^5.16.0",
+    "eslint-config-prettier": "^6.10.0",
+    "eslint-plugin-prettier": "^3.1.2",
     "eslint-plugin-vue": "^5.0.0",
+    "husky": "^4.2.1",
     "jest-serializer-vue": "^2.0.2",
     "less": "^3.10.3",
     "less-loader": "^5.0.0",
+    "lint-staged": "^10.0.4",
+    "prettier": "^1.19.1",
+    "prettier-eslint-cli": "^5.0.0",
+    "vue": "^2.6.10",
     "vue-template-compiler": "^2.6.10"
   },
-  "eslintConfig": {
+  "lint-staged": {
-    "root": true,
+    "**/*.{js,json,md,vue}": [
-    "env": {
+      "prettier --write"
-      "node": true
-    },
-    "extends": [
-      "plugin:vue/essential",
-      "eslint:recommended"
-    ],
-    "rules": {
-      "no-console": "warn"
-    },
-    "parserOptions": {
-      "parser": "babel-eslint"
-    },
-    "overrides": [
-      {
-        "files": [
-          "**/__tests__/*.{j,t}s?(x)",
-          "**/tests/unit/**/*.spec.{j,t}s?(x)"
-        ],
-        "env": {
-          "jest": true
-        }
-      }
     ]
   },
   "browserslist": [

prettier.config.js

@@ -0,0 +1,15 @@
+module.exports = {
+  printWidth: 100,
+  tabWidth: 2,
+  useTabs: false,
+  semi: false,
+  singleQuote: true,
+  jsxSingleQuote: true,
+  bracketSpacing: true,
+  jsxBracketSameLine: false,
+  rangeStart: 0,
+  rangeEnd: Infinity,
+  requirePragma: false,
+  insertPragma: false,
+  htmlWhitespaceSensitivity: 'css'
+}

readme.md

@@ -1,14 +1,29 @@
 [![Actions Status](https://github.com/ParadeTo/vue-tree-list/workflows/Test/badge.svg)](https://github.com/ParadeTo/vue-tree-list/actions)
 
 # vue-tree-list
+
 A vue component for tree structure. Support adding treenode/leafnode, editing node's name and dragging.
 
 ![vue-tree-demo.gif](https://raw.githubusercontent.com/ParadeTo/vue-tree-list/master/img/demo.gif)
 
 [Live Demo](http://paradeto.com/vue-tree-list/)
 
+# install
+
+Install the plugin then you can use the component globally.
+
+```js
+import Vue from 'vue'
+import VueTreeList from 'vue-tree-list'
+
+Vue.use(VueTreeList)
+```
+
+Or just register locally like the example below.
+
 # use
-``npm install vue-tree-list``
+
+`npm install vue-tree-list`
 
 ```html
 <template>
@@ -22,7 +37,13 @@ A vue component for tree structure. Support adding treenode/leafnode, editing no
       :model="data"
       default-tree-node-name="new node"
       default-leaf-node-name="new leaf"
-      v-bind:default-expanded="false">
+      v-bind:default-expanded="false"
+    >
+      <template v-slot:leafNameDisplay="slotProps">
+        <span>
+          {{ slotProps.model.name }} <span class="muted">#{{ slotProps.model.id }}</span>
+        </span>
+      </template>
       <span class="icon" slot="addTreeNodeIcon">📂</span>
       <span class="icon" slot="addLeafNodeIcon">＋</span>
       <span class="icon" slot="editNodeIcon">📃</span>
@@ -124,8 +145,7 @@ A vue component for tree structure. Support adding treenode/leafnode, editing no
         }
 
         vm.newTree = _dfs(vm.data)
-      },
+      }
-      
     }
   }
 </script>
@@ -150,58 +170,71 @@ A vue component for tree structure. Support adding treenode/leafnode, editing no
       cursor: pointer;
     }
   }
-</style>
 
+  .muted {
+    color: gray;
+    font-size: 80%;
+  }
+</style>
 ```
 
 # props
-## props of vue-tree-list
-| name | type | default | description |
-|:-----:|:-------:|:------------:|:----:|
-model | TreeNode | - | You can use `const head = new Tree([])` to generate a tree with the head of `TreeNode` type
-default-tree-node-name | string | New node node | Default name for new treenode
-default-leaf-node-name | string | New leaf node | Default name for new leafnode
-default-expanded | boolean | true | Tree is expanded or not
 
+## props of vue-tree-list
+
+|          name          |   type   |    default    |                                         description                                         |
+| :--------------------: | :------: | :-----------: | :-----------------------------------------------------------------------------------------: |
+|         model          | TreeNode |       -       | You can use `const head = new Tree([])` to generate a tree with the head of `TreeNode` type |
+| default-tree-node-name |  string  | New node node |                                Default name for new treenode                                |
+| default-leaf-node-name |  string  | New leaf node |                                Default name for new leafnode                                |
+|    default-expanded    | boolean  |     true      |                                   Tree is expanded or not                                   |
 
 ## props of TreeNode
+
 ### attributes
+
 |        name         |      type      |      default      |           description            |
-|:-----:|:-------:|:------------:|:----:|
+| :-----------------: | :------------: | :---------------: | :------------------------------: |
-id | string, number | current timestamp | The node's id
+|         id          | string, number | current timestamp |          The node's id           |
-isLeaf | boolean | false | The node is leaf or not
+|       isLeaf        |    boolean     |       false       |     The node is leaf or not      |
-dragDisabled | boolean | false | Forbid dragging tree node
+|    dragDisabled     |    boolean     |       false       |    Forbid dragging tree node     |
-addTreeNodeDisabled | boolean | false | Show `addTreeNode` button or not
+| addTreeNodeDisabled |    boolean     |       false       | Show `addTreeNode` button or not |
-addLeafNodeDisabled | boolean | false | Show `addLeafNode` button or not
+| addLeafNodeDisabled |    boolean     |       false       | Show `addLeafNode` button or not |
-editNodeDisabled | boolean | false | Show `editNode` button or not
+|  editNodeDisabled   |    boolean     |       false       |  Show `editNode` button or not   |
-delNodeDisabled | boolean | false | Show `delNode` button or not
+|   delNodeDisabled   |    boolean     |       false       |   Show `delNode` button or not   |
-children | array | null | The children of node
+|      children       |     array      |       null        |       The children of node       |
 
 ### methods
+
 |     name     |         params          |          description          |
-|:-----:|:-------:|:----:|
+| :----------: | :---------------------: | :---------------------------: |
-changeName | name | Change node's name
+|  changeName  |          name           |      Change node's name       |
-addChildren | children: object, array | Add children to node
+| addChildren  | children: object, array |     Add children to node      |
-remove | - | Remove node from the tree
+|    remove    |            -            |   Remove node from the tree   |
-moveInto | target: TreeNode | Move node into another node
+|   moveInto   |    target: TreeNode     |  Move node into another node  |
-insertBefore | target: TreeNode | Move node before another node
+| insertBefore |    target: TreeNode     | Move node before another node |
-insertAfter | target: TreeNode | Move node after another node
+| insertAfter  |    target: TreeNode     | Move node after another node  |
 
 # events
+
 |    name     |            params            |                                                                           description                                                                           |
-|:-----:|:-------:|:----:|
+| :---------: | :--------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: |
-click | TreeNode | Trigger when clicking a tree node
+|    click    |           TreeNode           |                                                                Trigger when clicking a tree node                                                                |
-change-name | {'id', 'oldName', 'newName'} | Trigger after changing a node's name
+| change-name | {'id', 'oldName', 'newName'} |                                                              Trigger after changing a node's name                                                               |
-delete-node | TreeNode | Trigger when clicking `delNode` button. You can call `remove` of `TreeNode` to remove the node.
+| delete-node |           TreeNode           |                                 Trigger when clicking `delNode` button. You can call `remove` of `TreeNode` to remove the node.                                 |
-add-node | TreeNode | Trigger after adding a new node
+|  add-node   |           TreeNode           |                                                                 Trigger after adding a new node                                                                 |
-drop | {node, src, target} | Trigger after dropping a node into another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop into
+|    drop     |     {node, src, target}      |   Trigger after dropping a node into another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop into   |
-drop-before | {node, src, target} | Trigger after dropping a node before another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop before
+| drop-before |     {node, src, target}      | Trigger after dropping a node before another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop before |
-drop-after | {node, src, target} | Trigger after dropping a node after another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop after
+| drop-after  |     {node, src, target}      |  Trigger after dropping a node after another. node: the draggable node, src: the draggable node's parent, target: the node that draggable node will drop after  |
 
 # customize operation icons
+
 The component has default icons for `addTreeNodeIcon`, `addLeafNodeIcon`, `editNodeIcon`, `delNodeIcon`, `leafNodeIcon`, `treeNodeIcon` button, but you can also customize them and can access `model`, `root`, `expanded` as below:
 
 ```html
+<template v-slot:leafNameDisplay="slotProps">
+  <span>{{ slotProps.model.name }} #{{ slotProps.model.id }}</span>
+</template>
 <template v-slot:addTreeNodeIcon="slotProps">
   <span class="icon">📂</span>
 </template>
@@ -219,6 +252,8 @@ The component has default icons for `addTreeNodeIcon`, `addLeafNodeIcon`, `editN
 </template>
 <template v-slot:treeNodeIcon="slotProps">
   <span class="icon">
-    {{ (slotProps.model.children && slotProps.model.children.length > 0 && !slotProps.expanded) ? '🌲' : '' }}</span>
+    {{ (slotProps.model.children && slotProps.model.children.length > 0 && !slotProps.expanded) ?
+    '🌲' : '' }}</span
+  >
 </template>
 ```

src/VueTreeList.vue

@@ -27,40 +27,25 @@
         @mouseout="mouseOut"
         @click.stop="click"
       >
-        <span
+        <span class="vtl-caret vtl-is-small" v-if="model.children && model.children.length > 0">
-          class="vtl-caret vtl-is-small"
+          <i class="vtl-icon" :class="caretClass" @click.prevent.stop="toggle"></i>
-          v-if="model.children && model.children.length > 0"
-        >
-          <i
-            class="vtl-icon"
-            :class="caretClass"
-            @click.prevent.stop="toggle"
-          ></i>
         </span>
 
         <span v-if="model.isLeaf">
-          <slot
+          <slot name="leafNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-            name="leafNodeIcon"
-            :expanded="expanded"
-            :model="model"
-            :root="rootNode"
-          >
             <i class="vtl-icon vtl-menu-icon vtl-icon-file"></i>
           </slot>
         </span>
         <span v-else>
-          <slot
+          <slot name="treeNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-            name="treeNodeIcon"
-            :expanded="expanded"
-            :model="model"
-            :root="rootNode"
-          >
             <i class="vtl-icon vtl-menu-icon vtl-icon-folder"></i>
           </slot>
         </span>
 
         <div class="vtl-node-content" v-if="!editable">
+          <slot name="leafNameDisplay" :expanded="expanded" :model="model" :root="rootNode">
             {{ model.name }}
+          </slot>
         </div>
         <input
           v-else
@@ -77,12 +62,7 @@
             @click.stop.prevent="addChild(false)"
             v-if="!model.isLeaf && !model.addTreeNodeDisabled"
           >
-            <slot
+            <slot name="addTreeNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-              name="addTreeNodeIcon"
-              :expanded="expanded"
-              :model="model"
-              :root="rootNode"
-            >
               <i class="vtl-icon vtl-icon-folder-plus-e"></i>
             </slot>
           </span>
@@ -91,40 +71,17 @@
             @click.stop.prevent="addChild(true)"
             v-if="!model.isLeaf && !model.addLeafNodeDisabled"
           >
-            <slot
+            <slot name="addLeafNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-              name="addLeafNodeIcon"
-              :expanded="expanded"
-              :model="model"
-              :root="rootNode"
-            >
               <i class="vtl-icon vtl-icon-plus"></i>
             </slot>
           </span>
-          <span
+          <span title="edit" @click.stop.prevent="setEditable" v-if="!model.editNodeDisabled">
-            title="edit"
+            <slot name="editNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-            @click.stop.prevent="setEditable"
-            v-if="!model.editNodeDisabled"
-          >
-            <slot
-              name="editNodeIcon"
-              :expanded="expanded"
-              :model="model"
-              :root="rootNode"
-            >
               <i class="vtl-icon vtl-icon-edit"></i>
             </slot>
           </span>
-          <span
+          <span title="delete" @click.stop.prevent="delNode" v-if="!model.delNodeDisabled">
-            title="delete"
+            <slot name="delNodeIcon" :expanded="expanded" :model="model" :root="rootNode">
-            @click.stop.prevent="delNode"
-            v-if="!model.delNodeDisabled"
-          >
-            <slot
-              name="delNodeIcon"
-              :expanded="expanded"
-              :model="model"
-              :root="rootNode"
-            >
               <i class="vtl-icon vtl-icon-trash"></i>
             </slot>
           </span>
@@ -155,6 +112,9 @@
         :model="model"
         :key="model.id"
       >
+        <template v-slot:leafNameDisplay="slotProps">
+          <slot name="leafNameDisplay" v-bind="slotProps" />
+        </template>
         <template v-slot:addTreeNodeIcon="slotProps">
           <slot name="addTreeNodeIcon" v-bind="slotProps" />
         </template>
@@ -185,6 +145,7 @@ import {addHandler, removeHandler} from './tools.js'
 let compInOperation = null
 
 export default {
+  name: 'vue-tree-list',
   data: function() {
     return {
       isHover: false,
@@ -265,7 +226,8 @@ export default {
       this.rootNode.$emit('change-name', {
         id: this.model.id,
         oldName: oldName,
-        newName: e.target.value
+        newName: e.target.value,
+        node: this.model
       })
     },
 
@@ -282,8 +244,16 @@ export default {
       })
     },
 
-    setUnEditable() {
+    setUnEditable(e) {
       this.editable = false
+      var oldName = this.model.name
+      this.model.changeName(e.target.value)
+      this.rootNode.$emit('change-name', {
+        id: this.model.id,
+        oldName: oldName,
+        newName: e.target.value,
+        eventType: 'blur'
+      })
     },
 
     toggle() {
@@ -332,7 +302,8 @@ export default {
     },
     dragEnter() {
       if (!compInOperation) return
-      if (this.model.isLeaf) return
+      if (compInOperation.model.id === this.model.id || !compInOperation || this.model.isLeaf)
+        return
       this.isDragEnterNode = true
     },
     dragLeave() {

src/index.js

@@ -2,7 +2,12 @@
  * Created by ayou on 17/7/21.
  */
 
-import VueTreeList from "./VueTreeList";
+import VueTreeList from './VueTreeList'
-import { Tree, TreeNode } from "./Tree";
+import { Tree, TreeNode } from './Tree'
 
-export { Tree, TreeNode, VueTreeList };
+VueTreeList.install = Vue => {
+  Vue.component(VueTreeList.name, VueTreeList)
+}
+
+export default VueTreeList
+export { Tree, TreeNode, VueTreeList }

src/tools.js

@@ -26,7 +26,7 @@ export const removeHandler = function (element, type) {
 }
 
 // depth first search
-export const traverseTree = (root) => {
+export const traverseTree = root => {
   var newRoot = {}
 
   for (var k in root) {

tests/unit/drag.spec.js

@@ -57,7 +57,12 @@ describe('Drag', () => {
     $tree3.trigger('dragstart', { dataTransfer: { setData: () => {} } })
     $tree1Bottom.trigger('drop')
     Vue.nextTick(() => {
-      expect(wrapper.findAll('.vtl-tree-node').at(2).attributes('id')).toBe('t3')
+      expect(
+        wrapper
+          .findAll('.vtl-tree-node')
+          .at(2)
+          .attributes('id')
+      ).toBe('t3')
       done()
     })
   })

tests/unit/slot.spec.js

@@ -30,22 +30,34 @@ describe('Slot', () => {
       propsData: { model: new Tree([]) },
       scopedSlots: {
         addTreeNodeIcon() {
-          return <span class="add-tree-node-icon">📂</span>
+          return <span class='add-tree-node-icon'>📂</span>
         },
         addLeafNodeIcon() {
-          return <span class="icon">＋</span>
+          return <span class='icon'>＋</span>
         },
         editNodeIcon() {
-          return <span class="icon">📃</span>
+          return <span class='icon'>📃</span>
         },
         delNodeIcon(slotProps) {
-          return (slotProps.model.isLeaf || !slotProps.model.children) ? <span class="del-node-icon">✂️</span> : <span />
+          return slotProps.model.isLeaf || !slotProps.model.children ? (
+            <span class='del-node-icon'>✂️</span>
+          ) : (
+            <span />
+          )
         },
         leafNodeIcon() {
-          return <span class="icon">🍃</span>
+          return <span class='icon'>🍃</span>
         },
         treeNodeIcon(slotProps) {
-          return <span class="tree-node-icon icon">{ slotProps.model.children && slotProps.model.children.length > 0 && !slotProps.expanded ? '🌲' : '❀' }</span>
+          return (
+            <span class='tree-node-icon icon'>
+              {slotProps.model.children &&
+              slotProps.model.children.length > 0 &&
+              !slotProps.expanded
+                ? '🌲'
+                : '❀'}
+            </span>
+          )
         }
       }
     })

vue.config.js

@@ -0,0 +1,5 @@
+module.exports = {
+  css: {
+    extract: false
+  }
+}