Gathering detailed insights and metrics for @forkfdawa/vue-treeselect
Gathering detailed insights and metrics for @forkfdawa/vue-treeselect
A multi-select component with nested options support for Vue.js
Installations
npm install @forkfdawa/vue-treeselectDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
16.13.0
NPM Version
8.1.0
Score
61.8
Supply Chain
97.1
Quality
74.8
Maintenance
50
Vulnerability
99.3
License
Releases
Unable to fetch releases
Contributors
1
Unable to fetch Contributors
Languages
3
JavaScript
Vue
Less
JavaScript (83.06%)
Vue (10.31%)
Less (6.63%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
Download Statistics
Total Downloads
1,624
Last Day
1
Last Week
15
Last Month
37
Last Year
235
GitHub Statistics
618 Commits
4 Branches
1 Contributors
Bundle Size
63.95 kB
Minified
17.12 kB
Minified + Gzipped
Maintainers
1
Package Meta Information
Latest Version
1.9.0
Package Id
@forkfdawa/vue-treeselect@1.9.0
Unpacked Size
1.49 MB
Size
337.44 kB
File Count
65
NPM Version
8.1.0
Node Version
16.13.0
Total Downloads
Cumulative downloads
Total Downloads
1,624
Last day
0%
1
Compared to previous day
Last week
25%
15
Compared to previous week
Last month
825%
37
Compared to previous month
Last year
-51.5%
235
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
8
Peer Dependencies
1
Dev Dependencies
81
@babel/core@babel/plugin-syntax-jsx@babel/plugin-transform-runtime@babel/preset-env@size-limit/preset-big-lib@vue/test-utilsautoprefixerbabel-eslintbabel-loaderbabel-plugin-istanbulbabel-plugin-transform-vue-jsxcache-loaderchalkcodecovconnect-history-api-fallbackcopy-webpack-plugincss-loaderentitieseslinteslint-config-riophaeeslint-friendly-formattereslint-import-resolver-webpackeslint-loadereslint-plugin-importeslint-plugin-reacteslint-plugin-unicorneslint-plugin-vueeventsource-polyfillexpressfriendly-errors-webpack-plugingh-pageshtml-webpack-pluginhttp-serverjasmine-corejstransformer-markdown-itkarmakarma-chrome-launcherkarma-coveragekarma-jasminekarma-jasmine-matcherskarma-sourcemap-loaderkarma-spec-reporterkarma-webpacklessless-loadermini-css-extract-pluginopenoptimize-css-assets-webpack-pluginorapostcss-loaderpre-commitpugpug-loaderpuppeteerraw-loaderregenerator-runtimerimrafrun-seriesscript-loadershallow-equalshelljsstring.prototype.repeatstrip-indentstylelintstylelint-config-xo-spaceterser-webpack-pluginurl-loadervodalvuevue-loadervue-style-loadervue-template-compilervuexwebpackwebpack-bundle-analyzerwebpack-cdn-pluginwebpack-dev-middlewarewebpack-hot-middlewarewebpack-mergewebpack-node-externalsyaku
Versions
vue-treeselect (a fork of @riophae's Vue-Treeselect: https://github.com/riophae/vue-treeselect)
A multi-select component with nested options support for Vue.js
Additions to the original component:
- Support for aria-labels
- Functionality that
- makes the screen reader read the aria-labels of the options
- recognizes when options are selected/deselected)
- informs the user if the branch is the option is branch/leaf node
Features
- Single & multiple select with nested options support
- Fuzzy matching
- Async searching
- Delayed loading (load data of deep level options only when needed)
- Keyboard support (navigate using Arrow Up & Arrow Down keys, select option using Enter key, etc.)
- Rich options & highly customizable
- Supports a wide range of browsers (see below)
- RTL support
Requires Vue 2.2+
Getting Started
It's recommended to install vue-treeselect via npm, and build your app using a bundler like webpack.
1npm install --save @forkfdawa/vue-treeselect
This example shows how to integrate vue-treeselect with your Vue SFCs.
1<!-- Vue SFC --> 2<template> 3 <div id="app"> 4 <treeselect v-model="value" :multiple="true" :options="options" /> 5 </div> 6</template> 7 8<script> 9 // import the component 10 import Treeselect from '@riophae/vue-treeselect' 11 // import the styles 12 import '@riophae/vue-treeselect/dist/vue-treeselect.css' 13 14 export default { 15 // register the component 16 components: { Treeselect }, 17 data() { 18 return { 19 // define the default value 20 value: null, 21 // define options 22 options: [ { 23 id: 'a', 24 label: 'a', 25 children: [ { 26 id: 'aa', 27 label: 'aa', 28 }, { 29 id: 'ab', 30 label: 'ab', 31 } ], 32 }, { 33 id: 'b', 34 label: 'b', 35 }, { 36 id: 'c', 37 label: 'c', 38 } ], 39 } 40 }, 41 } 42</script>
If you just don't want to use webpack or any other bundlers, you can simply include the standalone UMD build in your page. In this way, make sure Vue as a dependency is included before vue-treeselect.
1<html> 2 <head> 3 <!-- include Vue 2.x --> 4 <script src="https://cdn.jsdelivr.net/npm/vue@^2"></script> 5 <!-- include vue-treeselect & its styles. you can change the version tag to better suit your needs. --> 6 <script src="https://cdn.jsdelivr.net/npm/@riophae/vue-treeselect@^0.4.0/dist/vue-treeselect.umd.min.js"></script> 7 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@riophae/vue-treeselect@^0.4.0/dist/vue-treeselect.min.css"> 8 </head> 9 <body> 10 <div id="app"> 11 <treeselect v-model="value" :multiple="true" :options="options" /> 12 </div> 13 </body> 14 <script> 15 // register the component 16 Vue.component('treeselect', VueTreeselect.Treeselect) 17 18 new Vue({ 19 el: '#app', 20 data: { 21 // define the default value 22 value: null, 23 // define options 24 options: [ { 25 id: 'a', 26 label: 'a', 27 children: [ { 28 id: 'aa', 29 label: 'aa', 30 }, { 31 id: 'ab', 32 label: 'ab', 33 } ], 34 }, { 35 id: 'b', 36 label: 'b', 37 }, { 38 id: 'c', 39 label: 'c', 40 } ], 41 }, 42 }) 43 </script> 44</html>
Documentation & Live Demo
Note: please use a desktop browser since the website hasn't been optimized for mobile devices.
Browser Compatibility
- Chrome
- Edge
- Firefox
- IE ≥ 9
- Safari
It should function well on IE9, but the style can be slightly broken due to the lack of support of some relatively new CSS features, such as transition and animation. Nevertheless it should look 90% same as on modern browsers.
Bugs
You can use this pen to reproduce bugs and then open an issue.
Contributing
- Fork & clone the repo
- Install dependencies by
yarnornpm install - Check out a new branch
npm run dev& hack- Make sure
npm testpasses - Push your changes & file a pull request
Credits
This project is inspired by vue-multiselect, react-select and Ant Design. Special thanks go to their respective authors!
Some icons used in this project:
- "link" icon made by Smashicons is licensed under CC 3.0 BY
- "spinner" icon from SpinKit is licensed under the MIT License
- "caret" icon made by Dave Gandy is licensed under CC 3.0 BY
- "delete" icon made by Freepik is licensed under CC 3.0 BY
- "checkmark symbol" & "minus symbol" icons made by Catalin Fertu are licensed under CC 3.0 BY
License
Copyright (c) 2017-present Riophae Lee.
Released under the MIT License.
No vulnerabilities found.
No security vulnerabilities found.