element-plus/docs/en-US/component/select-v2.md

title	lang
Virtualized Select	en-US

Virtualized Select

:::tip

This component is still under testing, if you found any bug or issue please report it at GitHub for us to fix.

:::

:::tip

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

:::

Background

In some use-cases, a single selector may end up loading tens of thousands of rows of data. Rendering that much data into the DOM could be a burden to the browser, which can result in performance issues. For a better user and developer experience, we decided to add this component.

Basic usage

The simplest selector

:::demo

select-v2/basic-usage

:::

Multi select

The basic multi-select selector with tags

:::demo

select-v2/multiple

:::

Hide extra tags when the selected items are too many.

You can collapse tags to a text by using collapse-tags attribute. You can check them when mouse hover collapse text by using collapse-tags-tooltip attribute.

:::demo

select-v2/hide-extra-tags

:::

Filterable multi-select

When the options are overwhelmingly too many, you can use filterable option to enable filter feature for finding out the desired option

:::demo

select-v2/filterable

:::

Disabled selector and select options

You can choose to disable selector itself or the option.

:::demo

select-v2/disabled

:::

Option Grouping

We can group option as we wanted, as long as the data satisfies the pattern.

:::demo

select-v2/grouping

:::

Customized option renderer

We can define our own template for rendering the option in the popup.

:::demo

select-v2/customized-option

:::

Clearable selector

We can clear all the selected options at once, also applicable for single select.

:::demo

select-v2/clearable

:::

Create Option

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

By using the allow-create attribute, users can create new items by typing in the input box. Note that for allow-create to work, filterable must be true.

:::tip

It will be better to set :reserve-keyword="false" when use allow-create

:::

:::demo

select-v2/allow-create

:::

Remote search

Enter keywords and search data from server.

:::demo Set the value of filterable and remote with true to enable remote search, and you should pass the remote-method. remote-method is a Function that gets called when the input value changes, and its parameter is the current input value.

select-v2/remote-search

:::

Use value-key attribute

when options.value is an object, you should set a unique identity key name for value

::: tip

Before ^(2.4.0), value-key was used both as the unique value of the selected object and as an alias for the value in options. Now value-key is only used as the unique value of the selected object, and the alias for the value in options is props.value.

:::

:::demo

select-v2/use-valueKey

:::

Aliases for custom options ^(2.4.2)

When your options format is different from the default format, you can customize the alias of the options through the props attribute

:::demo

select-v2/props

:::

Custom Tag ^(2.5.0)

You can customize tags.

:::demo Insert customized tags into the slot of el-select. collapse-tags, collapse-tags-tooltip, max-collapse-tags will not work.

select-v2/custom-tag

:::

API

Attributes

Name	Description	Type	Default
model-value / v-model	biding value	^[string] / ^[number] / ^[boolean] / ^[object] / ^[array]	—
options	data of the options, the key of value and label can be customize by props	^[array]	—
props ^(2.4.2)	configuration options, see the following table	^[object]	—
multiple	is multiple	^[boolean]	false
disabled	is disabled	^[boolean]	false
value-key	unique identity key name for value, required when value is an object	^[string]	value
size	size of component	^[enum]'' | 'large' | 'default' | 'small'	''
clearable	whether select can be cleared	^[boolean]	false
clear-icon	custom clear icon	^[string] / ^[object]Component	CircleClose
collapse-tags	whether to collapse tags to a text when multiple selecting	^[boolean]	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	^[enum]'dark' | 'light' / ^[string]	light
autocomplete	autocomplete of select input	^[string]	off
placeholder	placeholder	^[string]	Please select
filterable	is filterable	^[boolean]	false
allow-create	whether creating new items is allowed. To use this, filterable must be true	^[boolean]	false
filter-method	custom filter method	^[Function]() => void	—
loading	whether Select is loading data from server	^[boolean]	false
loading-text	displayed text while loading data from server, default is 'Loading'	^[string]	—
reserve-keyword	whether reserve the keyword after select filtered option.	^[boolean]	true
no-match-text	displayed text when no data matches the filtering query, you can also use slot empty, default is 'No matching data'	^[string]	—
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-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]	false
teleported	whether select dropdown is teleported to the body	^[boolean]	true
persistent	when select dropdown is inactive and persistent is false, select dropdown will be destroyed	^[boolean]	true
popper-options	popper.js parameters	^[object]refer to popper.js doc	{}
automatic-dropdown	for non-filterable Select, this prop decides if the option menu pops up when the input is focused	^[boolean]	false
height	The height of the dropdown panel, 34px for each item	^[number]	274
item-height	The height of the dropdown item	^[number]	34
scrollbar-always-on	Controls whether the scrollbar is always displayed	^[boolean]	false
remote	whether search data from server	^[boolean]	false
remote-method	function that gets called when the input value changes. Its parameter is the current input value. To use this, filterable must be true	^[Function](keyword: string) => void	—
validate-event	whether to trigger form validation	^[boolean]	true
placement	position of dropdown	^[enum]'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end'	bottom-start
collapse-tags-tooltip ^(2.3.0)	whether show all selected tags when mouse hover text of collapse-tags. To use this, collapse-tags must be true	^[boolean]	false
max-collapse-tags ^(2.3.0)	The max tags number to be shown. To use this, collapse-tags must be true	^[number]	1
tag-type ^(2.5.0)	tag type	^[enum]'' | 'success' | 'info' | 'warning' | 'danger'	info
aria-label ^(a11y) ^(2.5.0)	same as aria-label in native input	^[string]	—

props

Attribute	Description	Type	Default
value	specify which key of node object is used as the node's value	^[string]	value
label	specify which key of node object is used as the node's label	^[string]	label
options	specify which key of node object is used as the node's children	^[string]	options
disabled	specify which key of node object is used as the node's disabled	^[string]	disabled

Events

Name	Description	Type
change	triggers when the selected value changes, the param is current selected value	^[Function](val: any) => void
visible-change	triggers when the dropdown appears/disappears, the param will be true when it appears, and false otherwise	^[Function](visible: boolean) => void
remove-tag	triggers when a tag is removed in multiple mode, the param is removed tag value	^[Function](tagValue: any) => void
clear	triggers when the clear icon is clicked in a clearable Select	^[Function]() => void
blur	triggers when Input blurs	^[Function](event: FocusEvent) => void
focus	triggers when Input focuses	^[Function](event: FocusEvent) => void

Slots

Name	Description
default	Option renderer
empty	content when options is empty
prefix	prefix content of input
tag ^(2.5.0)	content as Select tag

Exposes

Method	Description	Type
focus	focus the Input component	^[Function]() => void
blur	blur the Input component, and hide the dropdown	^[Function]() => void