feat(event): add drop-before and drop-after

Merge pull request #37 from zymawy/patch-1
Duplicate Declaration On onClick Method
2019-07-17 09:54:15 +08:00 · 2019-06-16 10:47:35 +08:00 · 2019-06-15 05:56:21 +03:00 · 2019-03-15 22:49:45 +08:00 · 2019-03-13 09:48:20 +01:00 · 2019-03-13 09:45:25 +01:00
7 changed files with 269 additions and 170 deletions
--- a/dev/App.vue
+++ b/dev/App.vue
@@ -3,13 +3,20 @@
        <button @click="addNode">Add Node</button>
        <vue-tree-list
          @click="onClick"
-          @change-name="onChange"
-          @delete-node="onChange"
-          @add-node="onChange"
+          @change-name="onChangeName"
+          @delete-node="onDel"
+          @add-node="onAddNode"
+          @drop="drop"
+          @drop-before="dropBefore"
+          @drop-after="dropAfter"
          :model="data"
          default-tree-node-name="new node"
          default-leaf-node-name="new leaf"
          v-bind:default-expanded="false">
+          <span class="icon" slot="addTreeNode">addTreeNode</span>
+          <span class="icon" slot="addLeafNode">addLeafNode</span>
+          <span class="icon" slot="editNode">editNode</span>
+          <span class="icon" slot="delNode">delNode</span>
        </vue-tree-list>
        <button @click="getNewTree">Get new tree</button>
        <pre>
@@ -32,6 +39,10 @@
            id: 1,
            pid: 0,
            dragDisabled: true,
+            addTreeNodeDisabled: true,
+            addLeafNodeDisabled: true,
+            editNodeDisabled: true,
+            delNodeDisabled: true,
            children: [
              {
                name: 'Node 1-2',
@@ -56,8 +67,33 @@
      }
    },
    methods: {
-      onChange (data) {
-        console.log(data)
+      onDel (node) {
+        console.log(node)
+        node.remove()
+      },
+
+      onChangeName (params) {
+        console.log(params)
+      },
+
+      onAddNode (params) {
+        console.log(params)
+      },
+
+      onClick (params) {
+        console.log(params)
+      },
+
+      drop: function ({node, src, target}) {
+        console.log('drop', node, src, target)
+      },
+
+      dropBefore: function ({node, src, target}) {
+        console.log('drop-before', node, src, target)
+      },
+
+      dropAfter: function ({node, src, target}) {
+        console.log('drop-after', node, src, target)
      },

      addNode () {
@@ -108,3 +144,11 @@
    }
  }
 </style>
+
+<style lang="less" rel="stylesheet/less" scoped>
+  .icon {
+    &:hover {
+      cursor: pointer;
+    }
+  }
+</style>
--- a/dev/index.html
+++ b/dev/index.html
@@ -3,7 +3,7 @@
 <head>
    <meta name="viewport" content="with=device-width,initial-scale=1.0,
      maximum-scale=1.0,minimum-scale=1.0,uses-scalable=no">
-    <title>vue-date-range</title>
+    <title>vue-tree-list</title>
 </head>
 <body>
 <div id="app"></div>
--- a/dist/vue-tree-list.min.js
+++ b/dist/vue-tree-list.min.js
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "vue-tree-list",
-  "version": "1.1.2",
+  "version": "1.3.2",
  "description": "A vue component for tree structure. Support adding treenode/leafnode, editing node's name and dragging.",
  "main": "dist/vue-tree-list.min.js",
  "scripts": {
@@ -54,10 +54,10 @@
    "sourcemap": "^0.1.0",
    "standard": "^12.0.1",
    "url-loader": "^0.5.7",
-    "vue": "^2.3.4",
+    "vue": "^2.6.6",
    "vue-loader": "^11.1.3",
    "vue-style-loader": "^2.0.3",
-    "vue-template-compiler": "^2.2.0",
+    "vue-template-compiler": "^2.6.6",
    "webpack": "^1.13.2",
    "webpack-dev-server": "1.14.0",
    "webpack-merge": "^0.14.1"
--- a/readme.md
+++ b/readme.md
@@ -9,145 +9,195 @@ A vue component for tree structure. Support adding treenode/leafnode, editing no
 ``npm install vue-tree-list``

 ```javascript
-<div>
-    <button @click="addNode">Add Node</button>
-    <vue-tree-list
-      @click="onClick"
-      @change-name="onChange"
-      @delete-node="onChange"
-      @add-node="onChange"
-      :model="data"
-      default-tree-node-name="new node"
-      default-leaf-node-name="new leaf"
-      v-bind:default-expanded="false">
-    </vue-tree-list>
-    <button @click="getNewTree">Get new tree</button>
-    <pre>
-      {{newTree}}
-    </pre>
-</div>
-...
-import { VueTreeList, Tree, TreeNode } from 'vue-tree-list'
-export default {
-  components: {
-    VueTreeList
-  },
-  data () {
-    return {
-      newTree: {},
-      data: new Tree([
-        {
-          name: 'Node 1',
-          id: 1,
-          pid: 0,
-          dragDisabled: true,
-          children: [
-            {
-              name: 'Node 1-2',
-              id: 2,
-              isLeaf: true,
-              pid: 1
-            }
-          ]
-        },
-        {
-          name: 'Node 2',
-          id: 3,
-          pid: 0,
-          disabled: true
-        },
-        {
-          name: 'Node 3',
-          id: 4,
-          pid: 0
-        }
-      ])
-    }
-  },
-  methods: {
-    onChange (data) {
-      console.log(data)
+<template>
+    <div>
+        <button @click="addNode">Add Node</button>
+        <vue-tree-list
+          @click="onClick"
+          @change-name="onChangeName"
+          @delete-node="onDel"
+          @add-node="onAddNode"
+          :model="data"
+          default-tree-node-name="new node"
+          default-leaf-node-name="new leaf"
+          v-bind:default-expanded="false">
+          <span class="icon" slot="addTreeNode">addTreeNode</span>
+          <span class="icon" slot="addLeafNode">addLeafNode</span>
+          <span class="icon" slot="editNode">editNode</span>
+          <span class="icon" slot="delNode">delNode</span>
+        </vue-tree-list>
+        <button @click="getNewTree">Get new tree</button>
+        <pre>
+          {{newTree}}
+        </pre>
+    </div>
+</template>
+<script>
+  import { VueTreeList, Tree, TreeNode } from 'vue-tree-list'
+  export default {
+    components: {
+      VueTreeList
    },
-
-    addNode () {
-      var node = new TreeNode({ name: 'new node', isLeaf: false })
-      if (!this.data.children) this.data.children = []
-      this.data.addChildren(node)
-    },
-
-    getNewTree () {
-      var vm = this
-      function _dfs (oldNode) {
-        var newNode = {}
-
-        for (var k in oldNode) {
-          if (k !== 'children' && k !== 'parent') {
-            newNode[k] = oldNode[k]
+    data () {
+      return {
+        newTree: {},
+        data: new Tree([
+          {
+            name: 'Node 1',
+            id: 1,
+            pid: 0,
+            dragDisabled: true,
+            addTreeNodeDisabled: true,
+            addLeafNodeDisabled: true,
+            editNodeDisabled: true,
+            delNodeDisabled: true,
+            children: [
+              {
+                name: 'Node 1-2',
+                id: 2,
+                isLeaf: true,
+                pid: 1
+              }
+            ]
+          },
+          {
+            name: 'Node 2',
+            id: 3,
+            pid: 0,
+            disabled: true
+          },
+          {
+            name: 'Node 3',
+            id: 4,
+            pid: 0
          }
-        }
-
-        if (oldNode.children && oldNode.children.length > 0) {
-          newNode.children = []
-          for (var i = 0, len = oldNode.children.length; i < len; i++) {
-            newNode.children.push(_dfs(oldNode.children[i]))
-          }
-        }
-        return newNode
+        ])
      }
-
-      vm.newTree = _dfs(vm.data)
    },
+    methods: {
+      onDel (node) {
+        console.log(node)
+        node.remove()
+      },

-    onClick(model) {
-      console.log(model)
+      onChangeName (params) {
+        console.log(params)
+      },
+
+      onAddNode (params) {
+        console.log(params)
+      },
+
+      onClick (params) {
+        console.log(params)
+      },
+
+      addNode () {
+        var node = new TreeNode({ name: 'new node', isLeaf: false })
+        if (!this.data.children) this.data.children = []
+        this.data.addChildren(node)
+      },
+
+      getNewTree () {
+        var vm = this
+        function _dfs (oldNode) {
+          var newNode = {}
+
+          for (var k in oldNode) {
+            if (k !== 'children' && k !== 'parent') {
+              newNode[k] = oldNode[k]
+            }
+          }
+
+          if (oldNode.children && oldNode.children.length > 0) {
+            newNode.children = []
+            for (var i = 0, len = oldNode.children.length; i < len; i++) {
+              newNode.children.push(_dfs(oldNode.children[i]))
+            }
+          }
+          return newNode
+        }
+
+        vm.newTree = _dfs(vm.data)
+      },
+      
    }
  }
-}
+</script>
+<style lang="less" rel="stylesheet/less">
+  .vtl {
+    .vtl-drag-disabled {
+      background-color: #d0cfcf;
+      &:hover {
+        background-color: #d0cfcf;
+      }
+    }
+    .vtl-disabled {
+      background-color: #d0cfcf;
+    }
+  }
+</style>
+
+<style lang="less" rel="stylesheet/less" scoped>
+  .icon {
+    &:hover {
+      cursor: pointer;
+    }
+  }
+</style>
+
 ```

 # props
-**default-tree-node-name**
-
-Default name for new treenode.
-
-**default-leaf-node-name**
-
-Default name for new leafnode.
+## 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


-**onDeleteNode**
-
-```javascript
-onDeleteNode(confirm) {
-  if (something) {
-    confirm()
-  }
-}
-```
-
-**default-expanded**
-
-Default node is expanded or not.
+## props of TreeNode
+### attributes
+| name | type | default | description |
+|:-----:|:-------:|:------------:|:----:|
+id | string, number | current timestamp | The node's id
+isLeaf | boolean | false | The node is leaf or not
+dragDisabled | boolean | false | Forbid dragging tree node
+addTreeNodeDisabled | boolean | false | Show `addTreeNode` button or not
+addLeafNodeDisabled | boolean | false | Show `addLeafNode` button or not
+editNodeDisabled | boolean | false | Show `editNode` button or not
+delNodeDisabled | boolean | false | Show `delNode` button or not
+children | array | null | The children of node

+### methods
+| name | params | description |
+|:-----:|:-------:|:----:|
+changeName | name | Change node's name
+addChildren | children: object, array | Add children to node
+remove | - | Remove node from the tree
+moveInto | target: TreeNode | Move node into another node
+insertBefore | target: TreeNode | Move node before another node
+insertAfter | target: TreeNode | Move node after another node

 # events
-**click**
+| name | params | description |
+|:-----:|:-------:|:----:|
+click | TreeNode | Trigger when clicking a tree node
+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.
+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-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

-**change-name**
+# customize operation icons
+The component has default icons for `addTreeNode`, `addLeafNode`, `editNode`, `delNode` button, but you can also customize them:

-**delete-node**
-
-**add-node**
-
-# Forbid dragging
-Use `dragDisabled` to forbid dragging:
-```javascript
-data: new Tree([
-  {
-    name: 'Node 1',
-    id: 1,
-    pid: 0,
-    dragDisabled: true,
-  ...
+```html
+<span class="icon" slot="addTreeNode">addTreeNode</span>
+<span class="icon" slot="addLeafNode">addLeafNode</span>
+<span class="icon" slot="editNode">editNode</span>
+<span class="icon" slot="delNode">delNode</span>
 ```
-
--- a/src/Tree.js
+++ b/src/Tree.js
@@ -10,10 +10,8 @@
 */
 const TreeNode = function (data) {
  const { id, isLeaf } = data
-  // this.name = name
  this.id = (typeof id === 'undefined') ? new Date().valueOf() : id
  this.parent = null
-  // this.pid = null
  this.children = null
  this.isLeaf = !!isLeaf

@@ -29,7 +27,7 @@ TreeNode.prototype.changeName = function (name) {
  this.name = name
 }

-TreeNode.prototype.addChildren = function (children, isNew) {
+TreeNode.prototype.addChildren = function (children) {
  if (!this.children) {
    this.children = []
  }
--- a/src/VueTreeList.vue
+++ b/src/VueTreeList.vue
@@ -2,7 +2,7 @@
  <div class='vtl'>
    <div v-if="model.name !== 'root'">
      <div class="vtl-border vtl-up" :class="{'vtl-active': isDragEnterUp}"
-        @drop="dropUp"
+        @drop="dropBefore"
        @dragenter="dragEnterUp"
        @dragover='dragOverUp'
        @dragleave="dragLeaveUp"></div>
@@ -37,23 +37,23 @@
        </div>
        <input v-else class="vtl-input" type="text" ref="nodeInput" :value="model.name" @input="updateName" @blur="setUnEditable">
        <div class="vtl-operation" v-show="isHover">
-          <span title="add tree node" @click.stop.prevent="addChild(false)" v-if="!model.isLeaf">
+          <span title="add tree node" @click.stop.prevent="addChild(false)" v-if="!model.isLeaf && !model.addTreeNodeDisabled">
            <slot name="addTreeNode">
              <i class="vtl-icon vtl-icon-folder-plus-e"></i>
            </slot>
          </span>
-          <span title="add tree node" @click.stop.prevent="addChild(true)" v-if="!model.isLeaf">
+          <span title="add leaf node" @click.stop.prevent="addChild(true)" v-if="!model.isLeaf && !model.addLeafNodeDisabled">
            <slot name="addLeafNode">
              <i class="vtl-icon vtl-icon-plus"></i>
            </slot>
          </span>
-          <span title="edit" @click.stop.prevent="setEditable">
-            <slot name="edit">
+          <span title="edit" @click.stop.prevent="setEditable" v-if="!model.editNodeDisabled">
+            <slot name="editNode">
              <i class="vtl-icon vtl-icon-edit"></i>
            </slot>
          </span>
-          <span title="delete" @click.stop.prevent="delNode">
-            <slot name="edit">
+          <span title="delete" @click.stop.prevent="delNode" v-if="!model.delNodeDisabled">
+            <slot name="delNode">
              <i class="vtl-icon vtl-icon-trash"></i>
            </slot>
          </span>
@@ -63,7 +63,7 @@
      <div v-if="model.children && model.children.length > 0 && expanded"
        class="vtl-border vtl-bottom"
        :class="{'vtl-active': isDragEnterBottom}"
-        @drop="dropBottom"
+        @drop="dropAfter"
        @dragenter="dragEnterBottom"
        @dragover='dragOverBottom'
        @dragleave="dragLeaveBottom"></div>
@@ -76,6 +76,10 @@
        v-bind:default-expanded="defaultExpanded"
        :model="model"
        :key='model.id'>
+          <slot name="addTreeNode" slot="addTreeNode" />
+          <slot name="addLeafNode" slot="addLeafNode" />
+          <slot name="editNode" slot="editNode" />
+          <slot name="delNode" slot="delNode" />
      </item>
    </div>
  </div>
@@ -85,7 +89,7 @@
  import { Tree, TreeNode } from './Tree.js'
  import { addHandler, removeHandler } from './tools.js'

-  let fromComp = null
+  let compInOperation = null

  export default {
    data: function () {
@@ -110,10 +114,6 @@
        type: String,
        default: 'New tree node'
      },
-      onDeleteNode: {
-        type: Function,
-        default: confirm => { confirm() }
-      },
      defaultExpanded: {
        type: Boolean,
        default: true
@@ -171,9 +171,6 @@
      },

      delNode () {
-        const vm = this
-        const confirm = () => vm.model.remove()
-        this.onDeleteNode(confirm)
        var node = this.getRootNode()
        node.$emit('delete-node', this.model)
      },
@@ -181,8 +178,9 @@
      setEditable () {
        this.editable = true
        this.$nextTick(() => {
-          this.$refs.nodeInput.focus()
-//          fireFocusEvent(this.$refs.nodeInput)
+          const $input = this.$refs.nodeInput
+          $input.focus()
+          $input.setSelectionRange(0, $input.value.length)
        })
      },

@@ -221,7 +219,7 @@

      dragStart(e) {
        if (!(this.model.dragDisabled || this.model.disabled)) {
-          fromComp = this
+          compInOperation = this
          // for firefox
          e.dataTransfer.setData("data","data");
          e.dataTransfer.effectAllowed = 'move'
@@ -230,14 +228,14 @@
        return false
      },
      dragEnd(e) {
-        fromComp = null
+        compInOperation = null
      },
      dragOver(e) {
        e.preventDefault()
        return true
      },
      dragEnter(e) {
-        if (!fromComp) return
+        if (!compInOperation) return
        if (this.model.isLeaf) return
        this.isDragEnterNode = true
      },
@@ -245,13 +243,16 @@
        this.isDragEnterNode = false
      },
      drop(e) {
-        if (!fromComp) return
-        fromComp.model.moveInto(this.model)
+        if (!compInOperation) return
+        const oldParent = compInOperation.model.parent;
+        compInOperation.model.moveInto(this.model)
        this.isDragEnterNode = false
+        var node = this.getRootNode();
+        node.$emit('drop', {target: this.model, node: compInOperation.model, src: oldParent})
      },

      dragEnterUp () {
-        if (!fromComp) return
+        if (!compInOperation) return
        this.isDragEnterUp = true
      },
      dragOverUp (e) {
@@ -259,17 +260,20 @@
        return true
      },
      dragLeaveUp () {
-        if (!fromComp) return
+        if (!compInOperation) return
        this.isDragEnterUp = false
      },
-      dropUp () {
-        if (!fromComp) return
-        fromComp.model.insertBefore(this.model)
+      dropBefore () {
+        if (!compInOperation) return
+        const oldParent = compInOperation.model.parent;
+        compInOperation.model.insertBefore(this.model)
        this.isDragEnterUp = false
+        var node = this.getRootNode();
+        node.$emit('drop-before', {target: this.model, node: compInOperation.model, src: oldParent})
      },

      dragEnterBottom () {
-        if (!fromComp) return
+        if (!compInOperation) return
        this.isDragEnterBottom = true
      },
      dragOverBottom (e) {
@@ -277,13 +281,16 @@
        return true
      },
      dragLeaveBottom () {
-        if (!fromComp) return
+        if (!compInOperation) return
        this.isDragEnterBottom = false
      },
-      dropBottom () {
-        if (!fromComp) return
-        fromComp.model.insertAfter(this.model)
+      dropAfter () {
+        if (!compInOperation) return
+        const oldParent = compInOperation.model.parent;
+        compInOperation.model.insertAfter(this.model)
        this.isDragEnterBottom = false
+        var node = this.getRootNode();
+        node.$emit('drop-after', {target: this.model, node: compInOperation.model, src: oldParent})
      },
      getRootNode() {
        var node = this.$parent
Author	SHA1	Message	Date
youxingzhi	cf41282fcf	feat(event): add drop-before and drop-after	2019-07-17 09:54:15 +08:00
ayou	6154cfd1ad	Merge pull request #37 from zymawy/patch-1 Duplicate Declaration On onClick Method	2019-06-16 10:47:35 +08:00
Hamza Ironside	51167862c9	Duplicate Declaration On onClick Method There Were Two Methods With The Same Name	2019-06-15 05:56:21 +03:00
ayou	e38102ed71	Merge pull request #27 from iakta/feature/drop-events Feature/drop events	2019-03-15 22:49:45 +08:00
Salvatore Giordano	d605642199	feat(events): add docs for drop and drop-up	2019-03-13 09:48:20 +01:00
Salvatore Giordano	62335d9eac	feat(events): rename event using dashes	2019-03-13 09:45:25 +01:00
Salvatore Giordano	625dadcb44	feat(events): add dropBottom event	2019-03-13 09:30:13 +01:00
youxingzhi	87b8a30bfb	fix(demo): change param name	2019-03-13 12:09:53 +08:00
youxingzhi	2164d032ca	feat: #23	2019-03-13 12:05:34 +08:00
Salvatore Giordano	538678d916	fix(events): fix oldParent object in drop events	2019-03-12 16:29:49 +01:00
Salvatore Giordano	dd3d61ddf7	feat(events): update version	2019-03-12 16:21:58 +01:00
Salvatore Giordano	e7757b97a7	feat(events): add oldParent information in drop event	2019-03-12 16:15:18 +01:00
Salvatore Giordano	76e67c583c	feat(events): emit drop and dropup events	2019-03-12 15:20:52 +01:00
youxingzhi	106708217f	chore(readme): fix format	2019-02-23 11:58:16 +08:00
youxingzhi	165d2dfb5d	chore(version): 1.3.0	2019-02-23 11:54:26 +08:00
youxingzhi	8f0a5d7737	feat: support closing operation icons	2019-02-23 11:52:58 +08:00
youxingzhi	a3b03a9579	chore(version): 1.2.0	2019-02-23 10:46:47 +08:00
youxingzhi	136b33971c	feat: support customizing operation icons	2019-02-23 10:44:34 +08:00