vue3-select/README.md

A maintained fork of vue-select for Vue 3

# vue3-select

This is a forked and maintained version of
[sagalbot/vue-select](https://github.com/sagalbot/vue-select), which is no
longer maintained. As the name suggests, this project is specifically designed
to work with the Vue 3.

**Notes**: At the moment, most of the features of vue3-select are the same as
the original vue-select project. As such, users can refer to the original
documentation for usage instructions.

## Documentation

New documentation specific to vue3-select will be available soon...

### New in vue3-select

- **[CSS variables](https://github.com/howard-tzw/vue3-select/blob/main/src/css/global/variables.css)**
- [optgroups](https://github.com/howard-tzw/vue3-select/blob/main/docs/api/props.md#options)

### Original documentation and examples

- **[API Documentation](https://vue-select.org)**
- **[CodePen Template](http://codepen.io/sagalbot/pen/NpwrQO)**

## Install

```bash
npm install vue3-select
```

Then, import and register the component:

```js
import Vue from 'vue'
import VueSelect from 'vue3-select'
import 'vue3-select/dist/vue3-select.css'

app.component('VSelect', VueSelect)
```

## License

[MIT](https://github.com/howard-tzw/vue3-select/blob/main/LICENSE.md)