Skip to content

Commit b5e239c

Browse files
author
Jeff
committed
doc content updates
1 parent db43a67 commit b5e239c

File tree

4 files changed

+22
-13
lines changed

4 files changed

+22
-13
lines changed

docs/.vuepress/config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ module.exports = {
8484
title: 'Digging Deeper',
8585
collapsable: false,
8686
children: [
87-
['guide/templating', 'Templating & Slots'],
87+
['guide/templating', 'Templating'],
8888
['guide/vuex', 'Vuex'],
8989
['guide/ajax', 'AJAX'],
9090
],

docs/guide/install.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
### Vue Compatibility
2-
- `vue 1.x` use `vue-select 1.x`
3-
41
## Yarn / NPM
52
Install with yarn:
63
```bash
@@ -17,7 +14,6 @@ Then, import and register the component:
1714
import Vue from 'vue'
1815
import vSelect from 'vue-select'
1916

20-
// register component
2117
Vue.component('v-select', vSelect)
2218
```
2319

@@ -33,18 +29,21 @@ You can also import the scss yourself for complete control of the component styl
3329
@import "vue-select/src/scss/vue-select.scss";
3430
```
3531

36-
## In the Browser / CDN
32+
## In the Browser
3733

38-
Include `vue` & `vue-select.js` - I recommend using [unpkg.com](https://unpkg.com/#/).
34+
vue-select ships as an UMD module that is accessible in the browser. When loaded
35+
in the browser, you can access the component through the `VueSelect.VueSelect`
36+
global variable. You'll need to load Vue.js, vue-select JS & vue-select CSS.
3937

4038
```html
4139
<!-- include VueJS first -->
4240
<script src="https://unpkg.com/vue@latest"></script>
4341

44-
<!-- use the latest release -->
42+
<!-- use the latest vue-select release -->
4543
<script src="https://unpkg.com/vue-select@latest"></script>
4644
<link rel="stylesheet" href="https://unpkg.com/vue-select@latest/dist/vue-select.css">
47-
<!-- or point to a specific release -->
45+
46+
<!-- or point to a specific vue-select release -->
4847
<script src="https://unpkg.com/vue-select@2.6.0"></script>
4948
<link rel="stylesheet" href="https://unpkg.com/vue-select@2.6.0/dist/vue-select.css">
5049
```
@@ -55,3 +54,8 @@ Vue.component('v-select', VueSelect.VueSelect);
5554
```
5655

5756
<CodePen url="dJjzeP" />
57+
58+
## Vue Compatibility
59+
60+
If you're on Vue `1.x`, use vue-select `1.x`. The `1.x` branch has not received updates
61+
since the 2.0 release.

docs/guide/options.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ component. No further configuration is necessary.
2929

3030
When `options` is an array of objects, the component must generate a label to be shown as the
3131
options text. By default, `vue-select` will attempt to render `option.label` as the option label.
32-
You can set your own label to match your source data using the `label` prop.
32+
You might not have a `label` key in your objects, so you can set your own label to match your
33+
source data using the `label {String}` prop.
3334

3435
For example, consider an object with `countryCode` and `countryName` properties:
3536

@@ -50,7 +51,7 @@ If you wanted to display `Canada` in the dropdown, you'd use the `countryName` k
5051

5152
## Null / Empty Options
5253

53-
`vue-select` requires the `option` property to be an `array`. If you are using Vue in development
54+
`vue-select` requires the `options` prop to be an `array`. If you are using Vue in development
5455
mode, you will get warnings attempting to pass anything other than an `array` to the `options` prop.
5556
If you need a `null`/`empty` value, use an empty array `[]`.
5657

@@ -59,4 +60,8 @@ If you need a `null`/`empty` value, use an empty array `[]`.
5960
To allow input that's not present within the options, set the `taggable` prop to true.
6061
If you want new tags to be pushed to the options list, set `push-tags` to true.
6162

62-
<v-select taggable />
63+
```html
64+
<v-select taggable multiple push-tags />
65+
```
66+
67+
<v-select taggable multiple push-tags />

docs/guide/values.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Getting / Setting
1+
## Getting and Setting
22

33
### `v-model`
44

0 commit comments

Comments
 (0)