mirror of
https://github.com/tenrok/vue-select.git
synced 2026-06-10 07:52:23 +03:00
Update install.md
This commit is contained in:
@@ -1,29 +1,46 @@
|
||||
<script setup>
|
||||
import CodePen from '../vitepress/components/CodePen.vue'
|
||||
</script>
|
||||
|
||||
## Yarn / NPM
|
||||
|
||||
Install with yarn or npm:
|
||||
|
||||
```bash
|
||||
# vue 2
|
||||
yarn add vue-select
|
||||
|
||||
# vue 3
|
||||
# Yarn
|
||||
yarn add vue-select@beta
|
||||
|
||||
# or, using NPM
|
||||
npm install vue-select
|
||||
# NPM
|
||||
npm install vue-select@beta
|
||||
```
|
||||
|
||||
Then, import and register the component:
|
||||
Next you'll import and register the component. You can register the component globally or locally. *
|
||||
Unsure what this means? Check
|
||||
the [VueJS docs on component registration](https://vuejs.org/guide/components/registration.html#component-registration)
|
||||
.*
|
||||
|
||||
### Global Registration
|
||||
|
||||
```js
|
||||
import Vue from 'vue'
|
||||
import { createApp } from "vue";
|
||||
import vSelect from "vue-select";
|
||||
|
||||
const app = createApp({});
|
||||
|
||||
app.component('vSelect', vSelect);
|
||||
```
|
||||
|
||||
### Local Registration
|
||||
|
||||
```vue
|
||||
|
||||
<script>
|
||||
import vSelect from 'vue-select'
|
||||
|
||||
Vue.component('v-select', vSelect)
|
||||
export default {
|
||||
components: { vSelect }
|
||||
}
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<vSelect />
|
||||
</template>
|
||||
```
|
||||
|
||||
The component itself does not include any CSS. You'll need to include it separately:
|
||||
@@ -35,7 +52,7 @@ import 'vue-select/dist/vue-select.css';
|
||||
## In the Browser
|
||||
|
||||
vue-select ships as an UMD module that is accessible in the browser. When loaded
|
||||
in the browser, you can access the component through the `VueSelect.VueSelect`
|
||||
in the browser, you can access the component through the `VueSelect.VueSelect`
|
||||
global variable. You'll need to load Vue.js, vue-select JS & vue-select CSS.
|
||||
|
||||
```html
|
||||
@@ -50,15 +67,21 @@ global variable. You'll need to load Vue.js, vue-select JS & vue-select CSS.
|
||||
<script src="https://unpkg.com/vue-select@3.0.0"></script>
|
||||
<link rel="stylesheet" href="https://unpkg.com/vue-select@3.0.0/dist/vue-select.css">
|
||||
```
|
||||
|
||||
Then register the component in your javascript:
|
||||
|
||||
```js
|
||||
Vue.component('v-select', VueSelect.VueSelect);
|
||||
```
|
||||
|
||||
<CodePen url="dJjzeP" />
|
||||
::code-pen
|
||||
---
|
||||
url: dJjzeP
|
||||
---
|
||||
|
||||
## Vue Compatibility
|
||||
|
||||
- Vue `2.x`, use vue-select `3.x`.
|
||||
- Vue `3.x`, use vue-select `3.x@beta`.
|
||||
| Vue | Vue Select | Notes |
|
||||
|------|------------|----------------------------------------------------------------------------|
|
||||
| ^2.3 | 3.x | The 3.x branch of Vue Select supports Vue 2.3 and above. View the v3 docs. |
|
||||
| ^3.0 | 4.0-beta | The latest version of Vue Select for Vue 3 applications. |
|
||||
|
||||
Reference in New Issue
Block a user