1
- # Vue3-Select-Component
1
+ < br />
2
2
3
3
<p align =" center " >
4
- <img src =" https://vue3-select-component.vercel.app/logo.png " alt =" Vue3 Select Component " height =" 256 " width =" 256 " />
4
+ <a href =" https://vue3-select-component.vercel.app/ " >
5
+ <img src="https://vue3-select-component.vercel.app/logo.png" alt="Vue3 Select Component" height="256" width="256" />
6
+ </a >
7
+ </p >
8
+
9
+ <h1 align =" center " >
10
+ Vue3-Select-Component
11
+ </h1 >
12
+
13
+ <p align =" center " >
14
+ Best-in-class select component for Vue 3, with a focus on DX, accessibility and ease-of-use.
5
15
</p >
6
16
7
17
<p align =" center " >
8
- <a href =" https://www.npmjs.com/package/vue3-select-component " >
9
- <img src="https://img.shields.io/npm/v/vue3-select-component.svg" alt="npm package" />
18
+ <a href =" https://www.npmjs.com/package/vue3-select-component " target = " __blank " >
19
+ <img src="https://img.shields.io/npm/v/vue3-select-component.svg?style=flat " alt="npm package" />
10
20
</a >
11
21
12
- <a href =" https://www.npmjs.com/package/vue3-select-component " >
13
- <img src="https://img.shields.io/npm/dm/vue3-select-component" alt="npm package" />
22
+ <a href =" https://www.npmjs.com/package/vue3-select-component " target = " __blank " >
23
+ <img src="https://img.shields.io/npm/dm/vue3-select-component?style=flat " alt="npm package" />
14
24
</a >
15
25
16
- <a href =" https://github.com/TotomInc/vue3-select-component/actions/workflows/build.yml " >
17
- <img src="https://github.com/ TotomInc/vue3-select-component/actions/workflows/build.yml/badge.svg?branch=master" alt="CI status" / >
26
+ <a href =" https://github.com/TotomInc/vue3-select-component " target = " __blank " >
27
+ <img alt="GitHub stars" src="https://img.shields.io/github/stars/ TotomInc/vue3-select-component?flat" >
18
28
</a >
19
29
</p >
20
30
21
31
<p align =" center " >
22
- < b >Docs & demos</ b >: <a href =" https://vue3-select-component.vercel.app " > vue3-select-component.vercel.app</a >
32
+ < a href = " https://vue3-select-component.vercel.app/ " target = " __blank " >Documentation</ a > | <a href =" https://vue3-select-component.vercel.app/getting-started.html " target = " __blank " >Getting Started</ a > | < a href = " https:// vue3-select-component.vercel.app/demo/single-select.html " target = " __blank " >Examples / Demos </a >
23
33
</p >
24
34
25
- > Best-in-class select component for Vue 3, with a focus on DX, accessibility and ease-of-use.
35
+ ** Core features: **
26
36
27
37
- ⚙️ Data manipulation with ` v-model `
28
- - 🔑 Type-safe
38
+ - 🔑 [ Typesafe relationship ] ( https://vue3-select-component.vercel.app/typescript.html ) between ` options ` and ` v-model `
29
39
- 🎨 Great styling out-of-the-box, customization with CSS variables & Vue ` :deep `
30
- - ✅ Single & multi-select
31
- - 🖌️ Customization with ` <slot> ` s
32
- - 🪄 Teleport/portal menu
33
- - 📦 Extremely light (3.1kb gzip)
40
+ - ✅ Single & multi-select support
41
+ - 🖌️ Infinite customization with ` <slot> ` s
42
+ - 🪄 ` < Teleport /> ` menu where you want
43
+ - 📦 Extremely light, ** 0 dependencies ** (4.4kb gzip)
34
44
35
45
## Installation
36
46
@@ -56,7 +66,7 @@ const option = ref("");
56
66
v-model="option"
57
67
:options="[
58
68
{ label: 'A Wizard of Earthsea', value: 'wizard_earthsea' },
59
- { label: 'Harry Potter and the Philosopher\'s Stone', value: 'harry_potter' },
69
+ { label: 'Harry Potter and the Philosopher\'s Stone', value: 'harry_potter', disabled: true },
60
70
{ label: 'The Lord of the Rings', value: 'the_lord_of_the_rings' },
61
71
]"
62
72
/>
@@ -96,6 +106,12 @@ const userOptions: UserOption[] = [
96
106
</template>
97
107
```
98
108
109
+ [ There's an entire documentation page] ( https://vue3-select-component.vercel.app/typescript.html ) dedicated to usage with TypeScript.
110
+
111
+ ## Releases
112
+
113
+ For changelog, visit [ releases] ( https://github.com/TotomInc/vue3-select-component/releases ) .
114
+
99
115
## License
100
116
101
117
MIT Licensed. Copyright (c) Thomas Cazade 2024 - present.
0 commit comments