Files
directus/docs/reference/app/components/v-select.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

2.6 KiB

Select

Renders a dropdown input.

<v-select
	v-model="value"
	:items="[
		{
			text: 'Item 1',
			value: 'item-1',
		},
		{
			text: 'Item 2',
			value: 'item-2',
		},
	]"
/>

Reference

Props

Prop Description Default Type
items* The items that should be selectable ItemsRaw
item-text Which prop should be taken to render the text 'text' String
item-value Which prop should be taken to mirror the selected value 'value' String
item-icon Which prop should be taken to render the icon null String
value Mirror with v-model the currently selected values null InputValue
multiple Allow to select multiple values false Boolean
placeholder A placeholder if no item is selected yet null String
full-width Display the select in full width true Boolean
disabled Disable any interaction with the select false Boolean
show-deselect Allow to deselect all currently selected items false Boolean
allow-other Allow to enter custom values false Boolean
close-on-content-click Close the dropdown when an selection has been made true Boolean
inline display the selection inline with other text false Boolean
multiple-preview-threshold The maximum amount of selected items to display in the preview 3 Number

CSS Variables

Variable Default
--v-select-font-family var(--family-sans-serif)

Slots

Slot Description Data
prepend Prepend anything to the selection

Events

Event Description Value
input