mirror of
https://gitee.com/element-plus/element-plus.git
synced 2024-12-14 17:31:02 +08:00
d9b7ef56ea
* style(docs): use css var * style: update * style: demo-icon use grid layout * style: remove demo-block.vue style scoped * docs: remove strange character
432 lines
12 KiB
Markdown
432 lines
12 KiB
Markdown
## Select V2 virtualized selector
|
||
|
||
:::tip
|
||
This component is still under testing, if you found any bug or issue please report it at [Github](https://github.com/element-plus/element-plus/issues) for us to fix.
|
||
:::
|
||
|
||
### Background
|
||
|
||
Now days, with tons of data came from the backend server through the internet, one single selector could have ended up loading tens of thousands of data from the backend, but rendering
|
||
that much data into the DOM could be a burden to the browser which could crash the browser. For better user experience and developer experience, we decided to add this component.
|
||
|
||
### Basic usage
|
||
|
||
The simplest selector
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value: '',
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Multi select
|
||
|
||
The basic multi-select selector with tags
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
multiple
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Hide extra tags when the selected items are too many.
|
||
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
multiple
|
||
collapse-tags
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### 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
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
filterable
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
multiple
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Disabled selector and select options
|
||
|
||
You can choose to disable selector itself or the option.
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
filterable
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; margin-right: 16px; vertical-align: middle;"
|
||
multiple
|
||
/>
|
||
<el-select-v2
|
||
disabled
|
||
v-model="value"
|
||
filterable
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; vertical-align: middle;"
|
||
multiple
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
disabled: idx % 10 === 0,
|
||
})),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Option Grouping
|
||
|
||
We can group option as we wanted, as long as the data satisfies the pattern.
|
||
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
filterable
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
multiple
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 10 }).map((_, idx) => {
|
||
const label = idx + 1
|
||
return {
|
||
value: `Group ${label}`,
|
||
label: `Group ${label}`,
|
||
options: Array.from({ length: 10 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1 + 10 * label}`,
|
||
label: `${initials[idx % 10]}${idx + 1 + 10 * label}`,
|
||
})),
|
||
}
|
||
}),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Customized option renderer
|
||
We can define our own template for rendering the option in the popup.
|
||
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value"
|
||
filterable
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px;"
|
||
multiple
|
||
>
|
||
<template #default="{item}">
|
||
<span style="margin-right: 8px;">{{ item.label }}</span>
|
||
<span style="color: var(--el-text-color-secondary); font-size: 13px">
|
||
{{ item.value }}
|
||
</span>
|
||
</template>
|
||
</el-select-v2>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value: [],
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Clearable selector
|
||
|
||
We can clear all the selected options at once, also applicable for single select.
|
||
|
||
:::demo
|
||
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value1"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; margin-right: 16px; vertical-align: middle;"
|
||
multiple
|
||
clearable
|
||
/>
|
||
<el-select-v2
|
||
v-model="value2"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; vertical-align: middle;"
|
||
clearable
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value1: [],
|
||
value2: '',
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
|
||
:::
|
||
|
||
### Create Option
|
||
Create and select new items that are not included in select options
|
||
:::demo 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`.
|
||
```html
|
||
<template>
|
||
<el-select-v2
|
||
v-model="value1"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; margin-right: 16px; vertical-align: middle;"
|
||
allow-create
|
||
filterable
|
||
multiple
|
||
clearable
|
||
/>
|
||
<el-select-v2
|
||
v-model="value2"
|
||
:options="options"
|
||
placeholder="Please select"
|
||
style="width: 200px; vertical-align: middle;"
|
||
allow-create
|
||
filterable
|
||
clearable
|
||
/>
|
||
</template>
|
||
|
||
<script>
|
||
const initials = ['a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j']
|
||
export default {
|
||
data() {
|
||
return {
|
||
options: Array.from({ length: 1000 }).map((_, idx) => ({
|
||
value: `Option ${idx + 1}`,
|
||
label: `${initials[idx % 10]}${idx}`,
|
||
})),
|
||
value1: [],
|
||
value2: '',
|
||
}
|
||
},
|
||
}
|
||
</script>
|
||
```
|
||
:::
|
||
|
||
### Remote search
|
||
|
||
WIP 👷♀️
|
||
|
||
### Keyboard navigation
|
||
|
||
WIP 👷♀️
|
||
|
||
:::tip
|
||
Some APIs are still undergoing (comparing to the non-virtualized select), because there were lots of legacy API refactors and new designs, the current version only implements the simplest and most used functionalities.
|
||
:::
|
||
|
||
### SelectV2 Attributes
|
||
| Param | Description | Type | Accepted Values | Default |
|
||
|---------- |-------------- |---------- |-------------------------------- |-------- |
|
||
| model-value / v-model | biding value | string / number / boolean / 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 | input box size | string | medium/small/mini | — |
|
||
| clearable | whether select can be cleared | boolean | — | false |
|
||
| 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 | — | — |
|
||
| autocomplete | select input 的 autocomplete 属性 | string | — | off |
|
||
| placeholder | the autocomplete attribute of select input | 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 |
|
||
| 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 | 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 |
|
||
| popper-options | Customized popper option see more at [popper.js](https://popper.js.org/documentation.html) | object | - | - |
|
||
| automatic-dropdown | for non-filterable Select, this prop decides if the option menu pops up when the input is focused | boolean | - | false |
|
||
| clear-icon | Customized clear icon class | string | — | el-icon-circle-close |
|
||
| height | The height of the dropdown panel, 34px for each item| number | - | 170 |
|
||
|
||
<span style="display: none;">
|
||
<!-- | no-match-text | 搜索条件无匹配时显示的文字，也可以使用`#empty`设置 | string | — | 无匹配数据 | -->
|
||
<!-- | reserve-keyword | 多选且可搜索时，是否在选中一个Option后保留当前的搜索关键词 | boolean | — | false |
|
||
| default-first-option | 在输入框按下回车，选择第一个匹配项。需配合 `filterable` 或 `remote` 使用 | boolean | - | false |
|
||
| clear-icon | 自定义清空图标的类名 | string | — | el-icon-circle-close |
|
||
| allow-create | 是否允许用户创建新条目，需配合 `filterable` 使用 | boolean | — | false |
|
||
| filter-method | 自定义搜索方法 | function | — | — |
|
||
| remote | 是否为远程搜索 | boolean | — | false |
|
||
| remote-method | 远程搜索方法 | function | — | — |
|
||
| loading | 是否正在从远程获取数据 | boolean | — | false |
|
||
| loading-text | 远程加载时显示的文字 | string | — | 加载中 | -->
|
||
</span>
|
||
|
||
### SelectV2 Events
|
||
| Event Name | Description | Params |
|
||
|---------|---------|---------|
|
||
| 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: Event) |
|
||
| focus | triggers when Input focuses | (event: Event) |
|
||
|
||
### SelectV2 Slots
|
||
| name | 说明 |
|
||
|---------|---------|
|
||
| default | Option renderer |
|
||
| empty | 无Option时的列表 |
|
||
|
||
<!-- | prefix | Select 组件头部内容 | -->
|