Home

Awesome

<p align="center"> <img alt="Vue Select Sides" src="https://raw.githubusercontent.com/soft4ti/vue-select-sides/master/static/logo.png" /> </p> <h2 align="center">Vue Select Sides</h2> <p align="center"> <a href="https://www.npmjs.com/package/vue-select-sides" target="_blank"> <img alt="npm" src="https://img.shields.io/npm/v/vue-select-sides?color=%23f57f1e"> </a> <a href="https://www.npmjs.com/package/vue-select-sides" target="_blank"> <img alt="npm" src="https://img.shields.io/bundlephobia/minzip/vue-select-sides?color=%23f57f1e"> </a> <a href="https://www.npmjs.com/package/vue-select-sides" target="_blank"> <img alt="npm" src="https://img.shields.io/npm/dw/vue-select-sides?color=%23f57f1e"> </a> </p>

A component for Vue.js to select double-sided data. The customer can select one or more items and ship them from side to side. Values can be displayed grouped or ungrouped.

From version v2.0.0 it is only compatible with Vue 3

<p align="center"> <img alt="Demo - Vue Select Sides" src="https://raw.githubusercontent.com/soft4ti/vue-select-sides/master/static/demo.gif" /> </p>

Live DEMO

Installation

First install it using:

npm install --save vue-select-sides

or

yarn add vue-select-sides

Then you can either use it as a component:

import vueSelectSides from "vue-select-sides";

export default {
  components: {
    vueSelectSides,
  },
};

Global component:

import vueSelectSides from "vue-select-sides";
Vue.use(VueSelectSides);
Vue.component("vue-select-sides", VueSelectSides);

Or if you wish to include it in a script tag, just include the vueSelectSides.umd.min.js file located in the dist folder as so:

<script src="dist/vueSelectSides.umd.min.js"></script>

Usage

The component has support for two types: mirror and grouped.

Import a theme

// modern
@import "/node_modules/vue-select-sides/styles/themes/soft.scss";
// or dark
@import "/node_modules/vue-select-sides/styles/themes/dark.scss";
// or light
@import "/node_modules/vue-select-sides/styles/themes/light.scss";

Grouped

Warning: v-model must be of type Object

<vue-select-sides
  type="grouped"
  v-model="selected"
  :list="list"
></vue-select-sides>
import vueSelectSides from "vue-select-sides";

export default {
  components: {
    vueSelectSides
  },
  data() {
    return {
      selected: {},
      list: [
        {
          value: "sul",
          label: "Sul",
          disabled: false,
          children: [
            {
              value: "santa-catarina",
              label: "Santa Catarina",
              disabled: false
            },
            {
              ...
            }
          ]
        },
        {
          value: "sudeste",
          label: "Sudeste",
          disabled: false,
          children: [
            {
              value: "minas-gerais",
              label: "Minas Gerais",
              disabled: false
            },
            {
              ...
            }
          ]
        }
      ]
    };
  }
};

Mirror

Warning: v-model must be of type Array

<vue-select-sides
  type="mirror"
  v-model="selected"
  :list="list"
></vue-select-sides>
import vueSelectSides from "vue-select-sides";

export default {
  components: {
    vueSelectSides
  },
  data() {
    return {
      selected: [],
      list: [
        {
          value: "afghanistan",
          label: "Afghanistan",
          disabled: true
        },
        {
          value: "brazil",
          label: "Brazil"
        },
        {
          value: "fiji",
          label: "Fiji",
          disabled: true
        },
        {
          value: "ghana",
          label: "Ghana"
        },
        {
          ...
        }
    ];
  }
};

Language/locales

List of locales available for the plugin:

Use global locale

import vueSelectSides from "vue-select-sides";

Vue.use(vueSelectSides, {
  locale: "pt_BR",
});

Vue.component("vue-select-sides", vueSelectSides);

Props

These are all the props you can pass to the component:

nametypeexamplenotes
v-modelArray or Object["xyz"] or {xyz: ["abc", "def"]}Use Object if type is grouped else uses Array
typeStringgrouped or mirror
listArray[{ value: "xyz", label: "Label xyz 01", disabled: true/false }]You can add the children key to type grouped
searchBooleantrue or falseTo show/hide search input. Default is visible (true)
totalBooleantrue or falseTo show/hide total selected in footer. Default is visible (true)
toggle-allBooleantrue or falseTo show/hide toggle in footer. Default is visible (true)
sort-selected-upBooleantrue or falseShow first the pre-selected. Default does not visible (false). Available only grouped type
order-byStringasc or descShow first the pre-selected. Default is natural order
lang (deprecated in v1.1)Stringen_US, pt_BR, es_ES or fr_FRLanguage default. Default is en_US<br>Use Use global locale
placeholder-search-leftString"Yay! Search items..."Placeholder on the left search field. Default is ""
placeholder-search-rightString"Or search children items..."Placeholder on the right search field. Default is ""

Bugs and feature requests

If your problem or idea is not <a href="https://github.com/juliorosseti/vue-select-sides/issues" target="_blank">addressed</a> yet, <a href="https://github.com/juliorosseti/vue-select-sides/issues/new" target="_blank">please open a new issue</a>.

Sponsor / Creator

<a href="http://softdesk.com.br/" target="_blank"> <img alt="Softdesk - Sponsor" src="https://raw.githubusercontent.com/juliorosseti/vue-select-sides/master/static/softdesk.png" /> </a>

Contribution / Development

Install dependencies

yarn install

Devserver

yarn run serve

Bundling

yarn run build

Donate

You can help with a donation on <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=E96JA5BH6XTHE&source=url" target="_blank">Paypal</a>

License

Vue select sides is open-sourced software licensed under the the <a href="https://opensource.org/licenses/MIT" target="_blank">MIT license</a>.