Skip to content

A Vue.js component that provides similar functionality to Select2 without the overhead of jQuery.

License

Notifications You must be signed in to change notification settings

enid-colic/vue-select

This branch is 450 commits behind sagalbot/vue-select:master.

Folders and files

NameName
Last commit message
Last commit date
Jan 23, 2018
Jan 15, 2018
Jan 23, 2018
Jan 9, 2018
Jan 23, 2018
Jan 23, 2018
May 30, 2016
Jan 23, 2018
May 28, 2016
Mar 12, 2017
May 28, 2016
May 28, 2016
Jan 5, 2018
Jan 15, 2018
Jan 23, 2018
Mar 31, 2017
Mar 10, 2016
Aug 16, 2017
Jan 15, 2018
Jul 4, 2016
Jan 23, 2018
Jan 23, 2018

Repository files navigation

vue-select Build Status Code Score Code Coverage No Dependencies MIT License Current Release

A native Vue.js select component that provides similar functionality to Select2 without the overhead of jQuery.

Features

  • AJAX Support
  • Tagging
  • List Filtering/Searching
  • Supports Vuex
  • Select Single/Multiple Options
  • Tested with Bootstrap 3/4, Bulma, Foundation
  • +95% Test Coverage
  • ~33kb minified with CSS
  • Zero dependencies

Documentation

Install

Vue Compatibility
  • vue ~2.0 use vue-select ~2.0
  • vue ~1.0 use vue-select ~1.0

NPM

Install the package. You should install [email protected] for use with vue ~1.0.

$ npm install vue-select

Register the component

import Vue from 'vue'
import vSelect from 'vue-select'
Vue.component('v-select', vSelect)

You may now use the component in your markup

<v-select v-model="selected" :options="['foo','bar']"></v-select>

CDN

Just include vue & vue-select.js - I recommend using unpkg.

<script src="https://unpkg.com/vue@latest"></script>
<!-- use the latest release -->
<script src="https://unpkg.com/vue-select@latest"></script>
<!-- or point to a specific release -->
<script src="https://unpkg.com/[email protected]"></script>

Then register the component in your javascript:

Vue.component('v-select', VueSelect.VueSelect);

You may now use the component in your markup

<v-select v-model="selected" :options="['foo','bar']"></v-select>

Here's an example on JSBin.

Basic Usage

Syncing a Selected Value

The most common use case for vue-select is to have the chosen value synced with a parent component. vue-select takes advantage of the v-model syntax to sync values with a parent.

<v-select v-model="selected"></v-select>
new Vue({
  data: {
    selected: null
  }
})

Setting Options

vue-select accepts arrays of strings and objects to use as options through the options prop.

<v-select :options="['foo','bar']"></v-select>

When provided an array of objects, vue-select will display a single value of the object. By default, vue-select will look for a key named 'label' on the object to use as display text.

<v-select :options="[{label: 'foo', value: 'Foo'}]"></v-select>

For more information, please visit the vue-select documentation.

About

A Vue.js component that provides similar functionality to Select2 without the overhead of jQuery.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 70.7%
  • Vue 25.5%
  • HTML 3.8%