mirror of
https://github.com/tenrok/vue-select.git
synced 2026-05-17 02:29:37 +03:00
docs: add sponsors and contributors pages (#1108)
This commit is contained in:
@@ -1,18 +1,22 @@
|
||||
# vue-select      
|
||||
# vue-select    [](https://coveralls.io/github/sagalbot/vue-select?branch=master) 
|
||||
|
||||
> **Everything you wish the HTML `<select>` element could do, wrapped up into a lightweight, zero
|
||||
dependency, extensible Vue component.**
|
||||
> **Everything you wish the HTML `<select>` element could do, wrapped up into a lightweight, zero
|
||||
> dependency, extensible Vue component.**
|
||||
|
||||
Vue Select is a feature rich select/dropdown/typeahead component. It provides a default
|
||||
template that fits most use cases for a filterable select dropdown. The component is designed to be as
|
||||
lightweight as possible, while maintaining high standards for accessibility,
|
||||
developer experience, and customization.
|
||||
|
||||
- Tagging
|
||||
- Filtering / Searching
|
||||
- Vuex Support
|
||||
- AJAX Support
|
||||
- SSR Support
|
||||
- Accessible
|
||||
- ~20kb Total / ~5kb CSS / ~15kb JS
|
||||
- Select Single/Multiple Options
|
||||
- Customizable with slots and SCSS variables
|
||||
- Tested with Bootstrap 3/4, Bulma, Foundation
|
||||
- +95% Test Coverage
|
||||
- Zero dependencies
|
||||
|
||||
## Documentation
|
||||
@@ -20,32 +24,47 @@ dependency, extensible Vue component.**
|
||||
Complete documentation and examples available at https://vue-select.org.
|
||||
|
||||
- **[API Documentation](https://vue-select.org)**
|
||||
- **[Sandbox Demo](https://vue-select.org/sandbox.html)**
|
||||
- **[CodePen Template](http://codepen.io/sagalbot/pen/NpwrQO)**
|
||||
- **[GitHub Projects](https://github.com/sagalbot/vue-select/projects)**
|
||||
|
||||
## Sponsors :tada:
|
||||
|
||||
It takes a lot of effort to maintain this project. If it has saved you development time, please consider [sponsoring the project](https://github.com/sponsors/sagalbot)
|
||||
with GitHub sponsors!
|
||||
|
||||
Huge thanks to the [sponsors](https://github.com/sponsors/sagalbot) and [contributors](https://github.com/sagalbot/vue-select/graphs/contributors) that make Vue Select possible.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
$ npm install vue-select
|
||||
yarn add vue-select
|
||||
|
||||
# or use npm
|
||||
|
||||
npm install vue-select
|
||||
```
|
||||
|
||||
Register the component
|
||||
Then, import and register the component:
|
||||
|
||||
```js
|
||||
import Vue from 'vue'
|
||||
import vSelect from 'vue-select'
|
||||
import Vue from "vue";
|
||||
import vSelect from "vue-select";
|
||||
|
||||
Vue.component('v-select', vSelect)
|
||||
Vue.component("v-select", vSelect);
|
||||
```
|
||||
|
||||
You may now use the component in your markup
|
||||
The component itself does not include any CSS. You'll need to include it separately:
|
||||
|
||||
```html
|
||||
<v-select v-model="selected" :options="['Vue.js','React']"></v-select>
|
||||
```js
|
||||
import "vue-select/dist/vue-select.css";
|
||||
```
|
||||
|
||||
You can also include vue-select directly in the browser. Check out the
|
||||
Alternatively, you can import the scss for complete control of the component styles:
|
||||
|
||||
```scss
|
||||
@import "vue-select/src/scss/vue-select.scss";
|
||||
```
|
||||
|
||||
You can also include vue-select directly in the browser. Check out the
|
||||
[documentation for loading from CDN.](https://vue-select.org/guide/install.html#in-the-browser).
|
||||
|
||||
## License
|
||||
|
||||
Reference in New Issue
Block a user