vue-treeselect - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

package.json

 {
   "name": "vue-treeselect",
   "description": "a tree select plugin for vue2",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "keywords": [
@@ -33,3 +33,3 @@ "vue2",
     "vue": "^2.3.3",
-    "vue-jstree": "^1.0.8",
+    "vue-jstree": "^2.1.6",
     "vue-loader": "^12.1.0",
@@ -36,0 +36,0 @@ "vue-template-compiler": "^2.3.3",

README.md

 # vue-treeselect
 
-> A Tree Select Plugin For Vue2.0+
+[![npm](https://img.shields.io/npm/dt/vue-treeselect.svg?style=flat-square)](https://github.com/zdy1988/vue-treeselect)
 
-![vue-treeselect](./pic.png)
+##  Introduction
 
+A tree plugin for vue2
+
+<img src="./pic.png" width="100%" align=center />
+
 This Plugin is based on [vue-jstree](https://github.com/zdy1988/vue-jstree), Some "props" can be used for reference !
 
+##  DEMO
+
+[http://zdy1988.github.io/vue-treeselect](http://zdy1988.github.io/vue-treeselect)
+
 ##  NPM
@@ -44,14 +52,19 @@
             {
+              "id": 1,
               "text": "Same but with checkboxes",
               "children": [
                 {
+                  "id": 2,
                   "text": "initially selected",
                 },
                 {
+                  "id": 3,
                   "text": "custom icon",
                 },
                 {
+                  "id": 4,
                   "text": "initially open",
                   "children": [
                     {
+                      "id": 5,
                       "text": "Another node"
@@ -62,5 +75,7 @@ }
                 {
+                  "id": 6,
                   "text": "custom icon",
                 },
                 {
+                  "id": 7,
                   "text": "disabled node",
@@ -72,14 +87,19 @@ "disabled": true
             {
+              "id": 8,
               "text": "Same but with checkboxes",
               "children": [
                 {
+                  "id": 9,
                   "text": "initially selected",
                 },
                 {
+                  "id": 10,
                   "text": "custom icon",
                 },
                 {
+                  "id": 11,
                   "text": "initially open",
                   "children": [
                     {
+                      "id": 12,
                       "text": "Another node"
@@ -90,5 +110,7 @@ }
                 {
+                  "id": 13,
                   "text": "custom icon",
                 },
                 {
+                  "id": 14,
                   "text": "disabled node",
@@ -100,2 +122,3 @@ "disabled": true
             {
+              "id": 15,
               "text": "And wholerow selection"
@@ -107,2 +130,32 @@ }
       })
-```
+```
+
+## API
+
+| Props        | Type           | Default  |  Describe  |
+| ------------- |:-------------:|:-----:|:--------------------------------------------------------|
+| placeholder      | String |  |  set  placeholder |
+| data      | Array |  |  set tree data  |
+| size      | String      |   |  set tree item size , value : 'large' or '' or ''small' |
+| show-checkbox | Boolean      |    false |  set it show checkbox |
+| allow-transition | Boolean      |    true | allow use transition animation  |
+| whole-row | Boolean      |    false | use whole row state |
+| no-dots | Boolean      |    false | show or hide dots || collapse | Boolean      |    false |  set all tree item collapse state |
+| multiple | Boolean      |    false |  set multiple selected tree item  |
+| allow-batch | Boolean      |    false | in multiple choices. allow batch select  |
+| text-field-name | String      |    'text' |  set tree item display field |
+| value-field-name | String      |    'value' |  set tree item value field |
+| children-field-name | String      |    'children' |  set tree item children field |
+| async | Function      |     |  async load callback function , if node is a leaf ,you can set 'isLeaf: true' in data  |
+| loading-text | String      |    'Loading' |  set loading text |
+| klass | String      |     |  set append tree class |
+
+## Data Item Optional Properties
+
+| Name        | Type           | Default  | Describe  |
+| ------------- |:-------------:| -----:|:----------------------------------------------|
+| icon      | String      |   | custom icon css class |
+| opened | Boolean      |    false | set leaf opened |
+| selected | Boolean      |    false | set node selected |
+| disabled | Boolean      |    false | set node disabled |
+| isLeaf | Boolean      |    false | if node is a leaf , set true can hide '+' |

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

407542

increased by9.21%

Lines of code

405

increased by4.11%

Number of lines in readme file

155

increased by51.96%

Worsened metrics

Number of package files

13

decreased by-7.14%

No dependency changes