Vue-Treeselect

A multi-select component with nested options support for Vue.js

AutocompleteTree / Explorer componentVue
riophae/vue-treeselectvue-treeselect.js.org/vue-treeselect

README

vue-treeselect npm Build Coverage

npm monthly downloads
jsDelivr monthly hits Known vulnerabilities License

A multi-select component with nested options support for Vue.js


Vue-Treeselect Screenshot

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.

  1. ``` sh
  2. npm install --save @riophae/vue-treeselect
  3. ```

This example shows how to integrate vue-treeselect with your Vue SFCs.

  1. ```vue

  3. <template>
  4.   <div id="app">
  5.     <treeselect v-model="value" :multiple="true" :options="options" />
  6.   </div>
  7. </template>
  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'

  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>
  43. ```

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. <html>
  3.   <head>
  4.     
  5.     <script src="https://cdn.jsdelivr.net/npm/vue@^2"></script>
  6.     
  7.     <script src="https://cdn.jsdelivr.net/npm/@riophae/vue-treeselect@^0.4.0/dist/vue-treeselect.umd.min.js"></script>
  8.     <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@riophae/vue-treeselect@^0.4.0/dist/vue-treeselect.min.css">
  9.   </head>
  10.   <body>
  11.     <div id="app">
  12.       <treeselect v-model="value" :multiple="true" :options="options" />
  13.     </div>
  14.   </body>
  15.   <script>
  16.     // register the component
  17.     Vue.component('treeselect', VueTreeselect.Treeselect)
  19.     new Vue({
  20.       el: '#app',
  21.       data: {
  22.         // define the default value
  23.         value: null,
  24.         // define options
  25.         options: [ {
  26.           id: 'a',
  27.           label: 'a',
  28.           children: [ {
  29.             id: 'aa',
  30.             label: 'aa',
  31.           }, {
  32.             id: 'ab',
  33.             label: 'ab',
  34.           } ],
  35.         }, {
  36.           id: 'b',
  37.           label: 'b',
  38.         }, {
  39.           id: 'c',
  40.           label: 'c',
  41.         } ],
  42.       },
  43.     })
  44.   </script>
  45. </html>
  46. ```

Documentation & Live Demo


Visit the website

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


1. Fork & clone the repo
2. Install dependencies by yarn or npm install
3. Check out a new branch
4. npm run dev & hack
5. Make sure npm test passes
6. 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.