Compare commits
9 Commits
v1.4.5
...
dependabot
Author | SHA1 | Date | |
---|---|---|---|
![]() |
f99283220b | ||
![]() |
7b677a6589 | ||
![]() |
a21f4b8adf | ||
![]() |
5b2fea32ad | ||
![]() |
347a927e90 | ||
![]() |
0f04f7edba | ||
![]() |
5500a36492 | ||
![]() |
66bc19baaa | ||
![]() |
97daf67f9a |
15
dev/App.vue
15
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>
|
||||
@@ -41,9 +46,8 @@
|
||||
</vue-tree-list>
|
||||
<button @click="getNewTree">Get new tree</button>
|
||||
<pre>
|
||||
{{ newTree }}
|
||||
</pre
|
||||
>
|
||||
{{ newTree }}
|
||||
</pre>
|
||||
</div>
|
||||
</template>
|
||||
<script>
|
||||
@@ -176,4 +180,9 @@ export default {
|
||||
cursor: pointer;
|
||||
}
|
||||
}
|
||||
|
||||
.muted {
|
||||
color: gray;
|
||||
font-size: 80%;
|
||||
}
|
||||
</style>
|
||||
|
20
package-lock.json
generated
20
package-lock.json
generated
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "vue-tree-list",
|
||||
"version": "1.4.5",
|
||||
"version": "1.5.0",
|
||||
"lockfileVersion": 1,
|
||||
"requires": true,
|
||||
"dependencies": {
|
||||
@@ -2405,7 +2405,7 @@
|
||||
},
|
||||
"util": {
|
||||
"version": "0.10.3",
|
||||
"resolved": "http://registry.npmjs.org/util/-/util-0.10.3.tgz",
|
||||
"resolved": "https://registry.npmjs.org/util/-/util-0.10.3.tgz",
|
||||
"integrity": "sha1-evsa/lCAUkZInj23/g7TeTNqwPk=",
|
||||
"dev": true,
|
||||
"requires": {
|
||||
@@ -3340,7 +3340,7 @@
|
||||
"dependencies": {
|
||||
"callsites": {
|
||||
"version": "2.0.0",
|
||||
"resolved": "http://registry.npmjs.org/callsites/-/callsites-2.0.0.tgz",
|
||||
"resolved": "https://registry.npmjs.org/callsites/-/callsites-2.0.0.tgz",
|
||||
"integrity": "sha1-BuuE8A7qQT2oav/vrL/7Ngk7PFA=",
|
||||
"dev": true
|
||||
}
|
||||
@@ -6783,6 +6783,12 @@
|
||||
"assert-plus": "^1.0.0"
|
||||
}
|
||||
},
|
||||
"git-cz": {
|
||||
"version": "4.7.4",
|
||||
"resolved": "https://registry.npmjs.org/git-cz/-/git-cz-4.7.4.tgz",
|
||||
"integrity": "sha512-s8r6JPuuFJXCiwB6uBlWYjDE6GlvIReSgVqYCfpRB+JbiBVNQLcBb93mH6bIJzz1lQU4R8+qlChhQIK8xp58Tg==",
|
||||
"dev": true
|
||||
},
|
||||
"glob": {
|
||||
"version": "7.1.6",
|
||||
"resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
|
||||
@@ -11080,9 +11086,9 @@
|
||||
"dev": true
|
||||
},
|
||||
"path-parse": {
|
||||
"version": "1.0.6",
|
||||
"resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.6.tgz",
|
||||
"integrity": "sha512-GSmOT2EbHrINBf9SR7CDELwlJ8AENk3Qn7OikK4nFYAu3Ote2+JYNVvkpAEQm3/TLNEJFD/xZJjzyxg3KBWOzw==",
|
||||
"version": "1.0.7",
|
||||
"resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
|
||||
"integrity": "sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==",
|
||||
"dev": true
|
||||
},
|
||||
"path-to-regexp": {
|
||||
@@ -12326,7 +12332,7 @@
|
||||
"dependencies": {
|
||||
"jsesc": {
|
||||
"version": "0.5.0",
|
||||
"resolved": "http://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz",
|
||||
"resolved": "https://registry.npmjs.org/jsesc/-/jsesc-0.5.0.tgz",
|
||||
"integrity": "sha1-597mbjXW/Bb3EP6R1c9p9w8IkR0=",
|
||||
"dev": true
|
||||
}
|
||||
|
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "vue-tree-list",
|
||||
"version": "1.4.5",
|
||||
"version": "1.5.0",
|
||||
"description": "A vue component for tree structure. Support adding treenode/leafnode, editing node's name and dragging.",
|
||||
"author": "ayou",
|
||||
"scripts": {
|
||||
@@ -10,7 +10,7 @@
|
||||
"test:coverage": "vue-cli-service test:unit --coverage",
|
||||
"lint": "vue-cli-service lint",
|
||||
"lint-staged": "lint-staged",
|
||||
"commit": "npx git-cz",
|
||||
"commit": "git-cz",
|
||||
"prepublish": "npm run build"
|
||||
},
|
||||
"main": "dist/vue-tree-list.umd.min.js",
|
||||
@@ -27,6 +27,7 @@
|
||||
"eslint-config-prettier": "^6.10.0",
|
||||
"eslint-plugin-prettier": "^3.1.2",
|
||||
"eslint-plugin-vue": "^5.0.0",
|
||||
"git-cz": "^4.7.4",
|
||||
"husky": "^4.2.1",
|
||||
"jest-serializer-vue": "^2.0.2",
|
||||
"less": "^3.10.3",
|
||||
|
118
readme.md
118
readme.md
@@ -1,6 +1,7 @@
|
||||
[](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.
|
||||
|
||||

|
||||
@@ -21,7 +22,8 @@ Vue.use(VueTreeList)
|
||||
Or just register locally like the example below.
|
||||
|
||||
# use
|
||||
``npm install vue-tree-list``
|
||||
|
||||
`npm install vue-tree-list`
|
||||
|
||||
```html
|
||||
<template>
|
||||
@@ -35,7 +37,13 @@ Or just register locally like the example below.
|
||||
: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>
|
||||
@@ -56,7 +64,7 @@ Or just register locally like the example below.
|
||||
components: {
|
||||
VueTreeList
|
||||
},
|
||||
data () {
|
||||
data() {
|
||||
return {
|
||||
newTree: {},
|
||||
data: new Tree([
|
||||
@@ -93,32 +101,32 @@ Or just register locally like the example below.
|
||||
}
|
||||
},
|
||||
methods: {
|
||||
onDel (node) {
|
||||
onDel(node) {
|
||||
console.log(node)
|
||||
node.remove()
|
||||
},
|
||||
|
||||
onChangeName (params) {
|
||||
onChangeName(params) {
|
||||
console.log(params)
|
||||
},
|
||||
|
||||
onAddNode (params) {
|
||||
onAddNode(params) {
|
||||
console.log(params)
|
||||
},
|
||||
|
||||
onClick (params) {
|
||||
onClick(params) {
|
||||
console.log(params)
|
||||
},
|
||||
|
||||
addNode () {
|
||||
addNode() {
|
||||
var node = new TreeNode({ name: 'new node', isLeaf: false })
|
||||
if (!this.data.children) this.data.children = []
|
||||
this.data.addChildren(node)
|
||||
},
|
||||
|
||||
getNewTree () {
|
||||
getNewTree() {
|
||||
var vm = this
|
||||
function _dfs (oldNode) {
|
||||
function _dfs(oldNode) {
|
||||
var newNode = {}
|
||||
|
||||
for (var k in oldNode) {
|
||||
@@ -137,8 +145,7 @@ Or just register locally like the example below.
|
||||
}
|
||||
|
||||
vm.newTree = _dfs(vm.data)
|
||||
},
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</script>
|
||||
@@ -163,58 +170,71 @@ Or just register locally like the example below.
|
||||
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
|
||||
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
|
||||
|
||||
| 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
|
||||
|
||||
| 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
|
||||
| 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
|
||||
|
||||
| name | params | description |
|
||||
| :---------: | :--------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------: |
|
||||
| click | TreeNode | Trigger when clicking a tree node. You can call `toggle` of `TreeNode` to toggle the folder 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 |
|
||||
|
||||
# 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>
|
||||
@@ -232,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>
|
||||
```
|
||||
|
@@ -43,7 +43,9 @@
|
||||
</span>
|
||||
|
||||
<div class="vtl-node-content" v-if="!editable">
|
||||
{{ model.name }}
|
||||
<slot name="leafNameDisplay" :expanded="expanded" :model="model" :root="rootNode">
|
||||
{{ model.name }}
|
||||
</slot>
|
||||
</div>
|
||||
<input
|
||||
v-else
|
||||
@@ -56,7 +58,7 @@
|
||||
/>
|
||||
<div class="vtl-operation" v-show="isHover">
|
||||
<span
|
||||
title="add tree node"
|
||||
:title="defaultAddTreeNodeTitle"
|
||||
@click.stop.prevent="addChild(false)"
|
||||
v-if="!model.isLeaf && !model.addTreeNodeDisabled"
|
||||
>
|
||||
@@ -65,7 +67,7 @@
|
||||
</slot>
|
||||
</span>
|
||||
<span
|
||||
title="add leaf node"
|
||||
:title="defaultAddLeafNodeTitle"
|
||||
@click.stop.prevent="addChild(true)"
|
||||
v-if="!model.isLeaf && !model.addLeafNodeDisabled"
|
||||
>
|
||||
@@ -110,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>
|
||||
@@ -157,11 +162,19 @@ export default {
|
||||
},
|
||||
defaultLeafNodeName: {
|
||||
type: String,
|
||||
default: 'New leaf node'
|
||||
default: 'Leaf Node'
|
||||
},
|
||||
defaultTreeNodeName: {
|
||||
type: String,
|
||||
default: 'New tree node'
|
||||
default: 'Tree Node'
|
||||
},
|
||||
defaultAddTreeNodeTitle: {
|
||||
type: String,
|
||||
default: 'Add Tree Node'
|
||||
},
|
||||
defaultAddLeafNodeTitle: {
|
||||
type: String,
|
||||
default: 'Add Leaf Node'
|
||||
},
|
||||
defaultExpanded: {
|
||||
type: Boolean,
|
||||
@@ -267,7 +280,10 @@ export default {
|
||||
},
|
||||
|
||||
click() {
|
||||
this.rootNode.$emit('click', this.model)
|
||||
this.rootNode.$emit('click', {
|
||||
toggle: this.toggle,
|
||||
...this.model
|
||||
})
|
||||
},
|
||||
|
||||
addChild(isLeaf) {
|
||||
|
@@ -47,7 +47,7 @@ exports[`Render render correctly 1`] = `
|
||||
<div class="vtl-node-content">
|
||||
Node 2
|
||||
</div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="add tree node"><i class="vtl-icon vtl-icon-folder-plus-e"></i></span> <span title="add leaf node"><i class="vtl-icon vtl-icon-plus"></i></span> <span title="edit"><i class="vtl-icon vtl-icon-edit"></i></span> <span title="delete"><i class="vtl-icon vtl-icon-trash"></i></span></div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="Add Tree Node"><i class="vtl-icon vtl-icon-folder-plus-e"></i></span> <span title="Add Leaf Node"><i class="vtl-icon vtl-icon-plus"></i></span> <span title="edit"><i class="vtl-icon vtl-icon-edit"></i></span> <span title="delete"><i class="vtl-icon vtl-icon-trash"></i></span></div>
|
||||
</div>
|
||||
<!---->
|
||||
</div>
|
||||
@@ -61,7 +61,7 @@ exports[`Render render correctly 1`] = `
|
||||
<div class="vtl-node-content">
|
||||
Node 3
|
||||
</div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="add tree node"><i class="vtl-icon vtl-icon-folder-plus-e"></i></span> <span title="add leaf node"><i class="vtl-icon vtl-icon-plus"></i></span> <span title="edit"><i class="vtl-icon vtl-icon-edit"></i></span> <span title="delete"><i class="vtl-icon vtl-icon-trash"></i></span></div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="Add Tree Node"><i class="vtl-icon vtl-icon-folder-plus-e"></i></span> <span title="Add Leaf Node"><i class="vtl-icon vtl-icon-plus"></i></span> <span title="edit"><i class="vtl-icon vtl-icon-edit"></i></span> <span title="delete"><i class="vtl-icon vtl-icon-trash"></i></span></div>
|
||||
</div>
|
||||
<!---->
|
||||
</div>
|
||||
|
@@ -11,7 +11,7 @@ exports[`Slot render slot correctly 1`] = `
|
||||
<div class="vtl-node-content">
|
||||
Node 1
|
||||
</div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="add tree node"><span class="add-tree-node-icon">📂</span></span> <span title="add leaf node"><span class="icon">+</span></span> <span title="edit"><span class="icon">📃</span></span> <span title="delete"><span></span></span></div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="Add Tree Node"><span class="add-tree-node-icon">📂</span></span> <span title="Add Leaf Node"><span class="icon">+</span></span> <span title="edit"><span class="icon">📃</span></span> <span title="delete"><span></span></span></div>
|
||||
</div>
|
||||
<div class="vtl-border vtl-bottom"></div>
|
||||
</div>
|
||||
@@ -42,7 +42,7 @@ exports[`Slot render slot correctly 1`] = `
|
||||
<div class="vtl-node-content">
|
||||
Node 2
|
||||
</div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="add tree node"><span class="add-tree-node-icon">📂</span></span> <span title="add leaf node"><span class="icon">+</span></span> <span title="edit"><span class="icon">📃</span></span> <span title="delete"><span class="del-node-icon">✂️</span></span></div>
|
||||
<div class="vtl-operation" style="display: none;"><span title="Add Tree Node"><span class="add-tree-node-icon">📂</span></span> <span title="Add Leaf Node"><span class="icon">+</span></span> <span title="edit"><span class="icon">📃</span></span> <span title="delete"><span class="del-node-icon">✂️</span></span></div>
|
||||
</div>
|
||||
<!---->
|
||||
</div>
|
||||
|
@@ -51,7 +51,7 @@ describe('Operation', () => {
|
||||
})
|
||||
|
||||
it('add leaf node', done => {
|
||||
const $node1AddLeafNode = wrapper.find('#t1 [title="add leaf node"]')
|
||||
const $node1AddLeafNode = wrapper.find('#t1 [title="Add Leaf Node"]')
|
||||
$node1AddLeafNode.trigger('click')
|
||||
Vue.nextTick(() => {
|
||||
expect(wrapper.findAll('.vtl-leaf-node').length).toBe(2)
|
||||
@@ -60,7 +60,7 @@ describe('Operation', () => {
|
||||
})
|
||||
|
||||
it('add tree node', done => {
|
||||
const $node1AddTreeNode = wrapper.find('#t1 [title="add tree node"]')
|
||||
const $node1AddTreeNode = wrapper.find('#t1 [title="Add Tree Node"]')
|
||||
$node1AddTreeNode.trigger('click')
|
||||
Vue.nextTick(() => {
|
||||
expect(wrapper.findAll('.vtl-tree-node').length).toBe(3)
|
||||
|
Reference in New Issue
Block a user