Select

When there are plenty of options, use a drop-down menu to display and select desired ones.

TIP

This component requires the <client-only></client-only> wrap when used in SSR (eg: Nuxt) and SSG (eg: VitePress).

Basic usage

Disabled option

Disabled select

Disable the whole component.

Clearable single select

You can clear Select using a clear icon.

Basic multiple select

Multiple select uses tags to display selected options.

Custom template

You can customize HTML templates for options.

Header of the dropdown 2.4.3

You can customize the header of the dropdown.

You can customize the footer of the dropdown.

Grouping

Display options in groups.

Option filtering

You can filter options for your desired ones.

Enter keywords and search data from server.

Create new items

Create and select new items that are not included in select options

Use value-key attribute

If the binding value of Select is an object, make sure to assign value-key as its unique identity key name.

Custom Tag 2.5.0

You can customize tags.

Custom Loading 2.5.2

Override loading content.

Select API

Select Attributes

NameDescriptionTypeDefault
model-value / v-modelbinding valuestring / number / boolean / object / array
multiplewhether multiple-select is activatedbooleanfalse
disabledwhether Select is disabledbooleanfalse
value-keyunique identity key name for value, required when value is an objectstringvalue
sizesize of Inputenum
clearablewhether select can be clearedbooleanfalse
collapse-tagswhether to collapse tags to a text when multiple selectingbooleanfalse
collapse-tags-tooltip 2.3.0whether show all selected tags when mouse hover text of collapse-tags. To use this, collapse-tags must be truebooleanfalse
multiple-limitmaximum number of options user can select when multiple is true. No limit when set to 0number0
namethe name attribute of select inputstring
effecttooltip theme, built-in theme: dark / lightenum / stringlight
autocompletethe autocomplete attribute of select inputstringoff
placeholderplaceholder, default is 'Select'string
filterablewhether Select is filterablebooleanfalse
allow-createwhether creating new items is allowed. To use this, filterable must be truebooleanfalse
filter-methodcustom filter methodFunction
remotewhether options are loaded from serverbooleanfalse
remote-methodcustom remote search methodFunction
remote-show-suffixin remote search method show suffix iconbooleanfalse
loadingwhether Select is loading data from serverbooleanfalse
loading-textdisplayed text while loading data from server, default is 'Loading'string
no-match-textdisplayed text when no data matches the filtering query, you can also use slot empty, default is 'No matching data'string
no-data-textdisplayed text when there is no options, you can also use slot empty, default is 'No data'string
popper-classcustom class name for Select's dropdownstring''
reserve-keywordwhen multiple and filterable is true, whether to reserve current keyword after selecting an optionbooleantrue
default-first-optionselect first matching option on enter key. Use with filterable or remotebooleanfalse
teleportedwhether select dropdown is teleported to the bodybooleantrue
persistentwhen select dropdown is inactive and persistent is false, select dropdown will be destroyedbooleantrue
automatic-dropdownfor non-filterable Select, this prop decides if the option menu pops up when the input is focusedbooleanfalse
clear-iconcustom clear icon componentstring / objectCircleClose
fit-input-widthwhether the width of the dropdown is the same as the inputbooleanfalse
suffix-iconcustom suffix icon componentstring / objectArrowDown
suffix-transition deprecatedanimation when dropdown appears/disappears iconbooleantrue
tag-typetag typeenuminfo
validate-eventwhether to trigger form validationbooleantrue
placement 2.2.17position of dropdownenumbottom-start
fallback-placements 2.5.6list of possible positions for dropdown popper.jsarrary['bottom-start', 'top-start', 'right', 'left']
max-collapse-tags 2.3.0the max tags number to be shown. To use this, collapse-tags must be truenumber1
popper-optionspopper.js parametersobjectrefer to popper.js doc{}
aria-label a11ysame as aria-label in native inputstring

WARNING

suffix-transition has been deprecated, and will be removed in 2.4.0, please use override style scheme.

Select Events

NameDescriptionType
changetriggers when the selected value changesFunction
visible-changetriggers when the dropdown appears/disappearsFunction
remove-tagtriggers when a tag is removed in multiple modeFunction
cleartriggers when the clear icon is clicked in a clearable SelectFunction
blurtriggers when Input blursFunction
focustriggers when Input focusesFunction

Select Slots

NameDescriptionSubtags
defaultoption component listOption Group / Option
header 2.4.3content at the top of the dropdown
footer 2.4.3content at the bottom of the dropdown
prefixcontent as Select prefix
emptycontent when there is no options
tag 2.5.0content as Select tag
loading 2.5.2content as Select loading

Select Exposes

MethodDescriptionType
focusfocus the Input componentFunction
blurblur the Input component, and hide the dropdownFunction

Option Group API

Option Group Attributes

NameDescriptionTypeDefault
labelname of the groupstring
disabledwhether to disable all options in this groupbooleanfalse

Option Group Slots

NameDescriptionSubtags
defaultcustomize default contentOption

Option API

Option Attributes

NameDescriptionTypeDefault
valuevalue of optionstring / number / boolean / object
labellabel of option, same as value if omittedstring / number
disabledwhether option is disabledbooleanfalse

Option Slots

NameDescription
defaultcustomize default content

Source

ComponentDocs

Contributors