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.

Grouping

Display options in groups.

Option filtering

You can filter options for your desired ones.

Remote Search

Enter keywords and search data from server.

Create new items

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

TIP

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

Select Attributes

Name	Description	Type	Accepted Values	Default
model-value / v-model	binding value	array / string / number / boolean / object	—	—
multiple	whether multiple-select is activated	boolean	true / false	false
disabled	whether Select is disabled	boolean	true / false	false
value-key	unique identity key name for value, required when value is an object	string	—	value
size	size of Input	string	large/default/small	default
clearable	whether select can be cleared	boolean	true / false	false
collapse-tags	whether to collapse tags to a text when multiple selecting	boolean	true / false	false
collapse-tags-tooltip	whether show all selected tags when mouse hover text of collapse-tags. To use this, `collapse-tags` must be true	boolean	true / false	false
multiple-limit	maximum number of options user can select when `multiple` is `true`. No limit when set to 0	number	—	0
name	the name attribute of select input	string	—	—
effect	Tooltip theme, built-in theme: `dark` / `light`	string	string	light
autocomplete	the autocomplete attribute of select input	string	—	off
placeholder	placeholder	string	—	Select
filterable	whether Select is filterable	boolean	true / false	false
allow-create	whether creating new items is allowed. To use this, `filterable` must be true	boolean	true / false	false
filter-method	custom filter method	function	—	—
remote	whether options are loaded from server	boolean	true / false	false
remote-method	custom remote search method	function	—	—
remote-show-suffix	in remote search method show suffix icon	boolean	true / false	false
loading	whether Select is loading data from server	boolean	true / false	false
loading-text	displayed text while loading data from server	string	—	Loading
no-match-text	displayed text when no data matches the filtering query, you can also use slot `empty`	string	—	No matching data
no-data-text	displayed text when there is no options, you can also use slot `empty`	string	—	No data
popper-class	custom class name for Select's dropdown	string	—	—
popper-options	Customized popper option see more at popper.js	object	—	—
reserve-keyword	when `multiple` and `filter` is true, whether to reserve current keyword after selecting an option	boolean	true / false	true
default-first-option	select first matching option on enter key. Use with `filterable` or `remote`	boolean	true / false	false
popper-append-to-body(deprecated)	whether to append the popper menu to body. If the positioning of the popper is wrong, you can try to set this prop to false	boolean	true / false	true
teleported	whether select dropdown is teleported to the body	boolean	true / false	true
persistent	when select dropdown is inactive and `persistent` is `false`, select dropdown will be destroyed	boolean	true / false	true
automatic-dropdown	for non-filterable Select, this prop decides if the option menu pops up when the input is focused	boolean	true / false	false
clear-icon	Custom clear icon component	`string \| Component`	—	CircleClose
fit-input-width	whether the width of the dropdown is the same as the input	boolean	true / false	false
suffix-icon	Custom suffix icon component	`string \| Component`	—	ArrowDown
suffix-transitiondeprecated	animation when dropdown appears/disappears icon	boolean	true / false	true
tag-type	tag type	string	success/info/warning/danger	info
validate-event	whether to trigger form validation	boolean	true / false	true
placement	position of dropdown	string	top/top-start/top-end/bottom/bottom-start/bottom-end/left/left-start/left-end/right/right-start/right-end	bottom-start
max-collapse-tags 2.3.0	The max tags number to be shown. To use this, `collapse-tags` must be true	number	—	1

WARNING

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

Select Events

Name	Description	Parameters
change	triggers when the selected value changes	current selected value
visible-change	triggers when the dropdown appears/disappears	true when it appears, and false otherwise
remove-tag	triggers when a tag is removed in multiple mode	removed tag value
clear	triggers when the clear icon is clicked in a clearable Select	—
blur	triggers when Input blurs	(event: FocusEvent)
focus	triggers when Input focuses	(event: FocusEvent)

Select Slots

Name	Description	Subtags
—	Option component list	Option Group / Option
prefix	content as Select prefix	—
empty	content when there is no options	—

Option Group Attributes

Name	Description	Type	Accepted Values	Default
label	name of the group	string	—	—
disabled	whether to disable all options in this group	boolean	—	false

Option Group Slots

Name	Description	Subtags
-	customize default content	Option

Option Attributes

Name	Description	Type	Accepted Values	Default
value	value of option	string / number / boolean / object	—	—
label	label of option, same as `value` if omitted	string/number	—	—
disabled	whether option is disabled	boolean	—	false