vue3-treeselect

A multi-select component with nested options support for Vue 3. Thank to riophae and his sources and library for vue 2 taken as basis.

Breaking changes from his library:

• property value => modelValue
• event input => updated:modelValue
• Now use slots with <template>

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 3.0+

Getting Started

npm install --save @pragnesh87/vue-treeselect

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

<!-- Vue SFC -->
<template>
  <div id="app">
    <treeselect v-model="value" :multiple="true" :options="options" />
  </div>
</template>

<script>
// import the component
import Treeselect from "vue3-treeselect";
// import the styles
import "vue3-treeselect/style.css";

export default {
  // register the component
  components: { Treeselect },
  data() {
    return {
      // define the default value
      value: null,
      // define options
      options: [
        {
          id: "a",
          label: "a",
          children: [
            {
              id: "aa",
              label: "aa",
            },
            {
              id: "ab",
              label: "ab",
            },
          ],
        },
        {
          id: "b",
          label: "b",
        },
        {
          id: "c",
          label: "c",
        },
      ],
    };
  },
};
</script>

Vue 3 Example

<template>
    <treeselect class="vue-treeselect-compact" :open-on-click="true" :clearable="false" :open-on-focus="true"
        :open-on-hover="true" :searchable="false" :disable-branch-nodes="true" placeholder="Loading..." :show-count="true"
        :default-expand-level="1" :options="status" :scrollPositionOnCenter="true" :append-to-body="false"
        v-model="currentStatus">
        <template v-slot:valueLabel="{ node }">
            {{ node.raw.customLabel ? node.raw.customLabel : node.raw.label }}
        </template>
        <template v-slot:optionLabel="{ node, shouldShowCount, count, labelClassName, countClassName }"
            :class="labelClassName">
            {{ node.label }}
            <span v-if="shouldShowCount" :class="countClassName">({{ count }})</span>
        </template>
    </treeselect>
</template>
<style>
@import '@pragnesh87/vue-treeselect/style.css';
</style>
<script setup>
import { ref } from 'vue';
import Treeselect from '@pragnesh87/vue-treeselect';
const currentStatus = ref('31');
const status = [
    {
        "id": "1",
        "label": "NEW"
    },
    {
        "id": "2",
        "label": "APPROVED"
    },
    {
        "id": "3",
        "label": "ONHOLD",
        "isDefaultExpanded": false,
        "children": [
            {
                "id": "31",
                "label": "Awaiting stock",
                "customLabel": "ONHOLD - Awaiting stock"
            },
            {
                "id": "32",
                "label": "Awaiting customer details",
                "customLabel": "ONHOLD - Awaiting customer details"
            },
        ]
    },
    {
        "id": "4",
        "label": "REJECTED"
    },

];
</script>

Browser Compatibility

• Chrome
• Edge
• Firefox
• 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 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-treeselect. 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

Released under the MIT License.