v-select2-component

0.4.7 • Public • Published

Vue Select2 Component

This project was generated with Vue cli version 2.9.1.

Instructions

This project is built for showing how to use v-select2-component.

v-select2-component

Source code in: https://github.com/godbasin/vue-select2/tree/npm-publish-code.

Related Versions

Vue-Select2-Component is baseed on these plugins and libs(version):

How to use


Install

// npm install
npm install v-select2-component --save

Use as component

  1. import as global component.
// import Select2Component
import Select2 from 'v-select2-component';

Vue.component('Select2', Select2);
new Vue({
	// ...
})
  1. import into a single component.
// import Select2Component
import Select2 from 'v-select2-component';

<template>
  <div>
    <Select2 v-model="myValue" :options="myOptions" :settings="{ settingOption: value, settingOption: value }" @change="myChangeEvent($event)" @select="mySelectEvent($event)" />
    <h4>Value: {{ myValue }}</h4>
  </div>
</template>
<script>
export default {
    // declare Select2Component
    components: {Select2},
    data() {
        return {
            myValue: '',
            myOptions: ['op1', 'op2', 'op3'] // or [{id: key, text: value}, {id: key, text: value}]
        }
    },
    methods: {
        myChangeEvent(val){
            console.log(val);
        },
        mySelectEvent({id, text}){
            console.log({id, text})
        }
    }
}
</script>

Options

  • options: option[]
    • select options for select2
    • option: {id: key, text: value} or string
  • v-model: option value that is selected
    • id or string while multiple is disable
    • id[] or string[] while multiple is enable
  • change
    • callback when option selected change
    • return value
    • parmas: same with v-model
  • select
    • callback when option selected
    • parmas: option({id: value, text: key, selected: ifSelected} or string)
  • disabled
    • if select is disabled
  • placeholder
    • placeholder attribute for select element
  • id
    • id attribute for select element
  • name
    • name attribute for select element
  • settings
    • configurable settings, see Select2 options API
    • setting: { settingOption: value, settingOption: value }

Readme

Keywords

Package Sidebar

Install

npm i v-select2-component

Weekly Downloads

4,680

Version

0.4.7

License

MIT

Unpacked Size

25.9 kB

Total Files

7

Last publish

Collaborators

  • godbasin