2
0
mirror of https://github.com/tenrok/vue-select.git synced 2026-05-26 04:34:04 +03:00
Files
vue-select/docs/getting-started/options.md
T
Jeff Sagal 699d595f9a WIP: V3 - Remove index prop, add reduce prop (#800)
* remove `index` in favour of `reduce`, tests passing

* refactor findOptionFromReducedValue

* - always use getOptionLabel in comparisons

* - refactor deselect method
- add missing jsdoc blocks
- organize methods

* bump documentation
2019-03-24 19:23:30 -07:00

1.6 KiB

Dropdown Options

Options Prop

vue-select accepts arrays of primitive values or objects to use as options through the options prop:

<!-- array of strings or numbers -->
<v-select :options="['foo','bar']"></v-select>

<!-- or, an array of objects -->
<v-select :options="[{label: 'foo', value: 'Foo'}]"></v-select>

Option Labels

Option Primitives (strings, numbers)

When options contains strings or numbers, they'll be used as the label for the option within the component. No further configuration is necessary.

Option Objects

When options is an array of objects, the component must generate a label to be shown as the options text. By default, vue-select will attempt to render option.label as the option label. You can set your own label to match your source data using the label prop.

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

{
  countryCode: "CA",
  countryName: "Canada"
}

If you wanted to display Canada in the dropdown, you'd use the countryName key:

<v-select label="countryName" :options="countries"></v-select>

Null / Empty Options

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

Tagging

To allow input that's not present within the options, set the taggable prop to true. If you want new tags to be pushed to the options list, set push-tags to true.