Select 选择器
下拉选择器。
何时使用
- 弹出一个下拉菜单给用户选择操作,用于代替原生的选择器,或者需要一个更优雅的多选器时。
- 当选项少时(少于 5 项),建议直接将选项平铺,使用 Radio 是更好的选择。
代码演示
基本使用。
<template>
<a-select
v-model:value="value1"
style="width: 120px"
@focus="focus"
ref="select"
@change="handleChange"
>
<a-select-option value="jack">Jack</a-select-option>
<a-select-option value="lucy">Lucy</a-select-option>
<a-select-option value="disabled" disabled>Disabled</a-select-option>
<a-select-option value="Yiminghe">yiminghe</a-select-option>
</a-select>
<a-select v-model:value="value2" style="width: 120px" disabled>
<a-select-option value="lucy">Lucy</a-select-option>
</a-select>
<a-select v-model:value="value3" style="width: 120px" loading>
<a-select-option value="lucy">Lucy</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const focus = () => {
console.log('focus');
};
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
return {
focus,
handleChange,
value1: ref('lucy'),
value2: ref('lucy'),
value3: ref('lucy'),
};
},
});
</script>
tags select,随意输入的内容(scroll the menu)
<template>
<a-select
v-model:value="value"
mode="tags"
style="width: 100%"
placeholder="Tags Mode"
@change="handleChange"
>
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
return {
value: ref([]),
handleChange,
};
},
});
</script>
默认情况下 onChange
里只能拿到 value,如果需要拿到选中的节点文本 label,可以使用 labelInValue
属性。 选中项的 label 会被包装到 value 中传递给 onChange
等函数,此时 value 是一个对象。
<template>
<a-select label-in-value v-model:value="value" style="width: 120px" @change="handleChange">
<a-select-option value="jack">Jack (100)</a-select-option>
<a-select-option value="lucy">Lucy (101)</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
interface Value {
key?: string;
label?: string;
}
export default defineComponent({
setup() {
const handleChange = (value: Value) => {
console.log(value); // { key: "lucy", label: "Lucy (101)" }
};
return {
value: ref<Value>({ key: 'lucy' }),
handleChange,
};
},
});
</script>
省市联动是典型的例子。 推荐使用 Cascader 组件。
<template>
<a-select v-model:value="province" style="width: 120px">
<a-select-option v-for="pro in provinceData" :key="pro">
{{ pro }}
</a-select-option>
</a-select>
<a-select v-model:value="secondCity" style="width: 120px">
<a-select-option v-for="city in cities" :key="city">
{{ city }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
const provinceData = ['Zhejiang', 'Jiangsu'];
const cityData: Record<string, string[]> = {
Zhejiang: ['Hangzhou', 'Ningbo', 'Wenzhou'],
Jiangsu: ['Nanjing', 'Suzhou', 'Zhenjiang'],
};
import { defineComponent, reactive, toRefs, computed, watch } from 'vue';
export default defineComponent({
setup() {
const province = provinceData[0];
const state = reactive({
province,
provinceData,
cityData,
secondCity: cityData[province][0],
});
const cities = computed(() => {
return cityData[state.province];
});
watch(
() => state.province,
val => {
state.secondCity = state.cityData[val][0];
},
);
return {
...toRefs(state),
cities,
};
},
});
</script>
搜索和远程数据结合。
<template>
<a-select
show-search
v-model:value="value"
placeholder="input search text"
style="width: 200px"
:default-active-first-option="false"
:show-arrow="false"
:filter-option="false"
:not-found-content="null"
@search="handleSearch"
@change="handleChange"
>
<a-select-option v-for="d in data" :key="d.value">
{{ d.text }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import jsonp from 'fetch-jsonp';
import querystring from 'querystring';
import { defineComponent, ref } from 'vue';
let timeout: any;
let currentValue = '';
function fetch(value: string, callback: any) {
if (timeout) {
clearTimeout(timeout);
timeout = null;
}
currentValue = value;
function fake() {
const str = querystring.encode({
code: 'utf-8',
q: value,
});
jsonp(`https://suggest.taobao.com/sug?${str}`)
.then(response => response.json())
.then(d => {
if (currentValue === value) {
const result = d.result;
const data: any[] = [];
result.forEach((r: any) => {
data.push({
value: r[0],
text: r[0],
});
});
callback(data);
}
});
}
timeout = setTimeout(fake, 300);
}
export default defineComponent({
setup() {
const data = ref<any[]>([]);
const value = ref();
const handleSearch = (val: string) => {
fetch(val, (d: any[]) => (data.value = d));
};
const handleChange = (val: string) => {
console.log(val);
value.value = val;
fetch(val, (d: any[]) => (data.value = d));
};
return {
handleSearch,
handleChange,
data,
value,
};
},
});
</script>
一个带有远程搜索,节流控制,请求时序控制,加载状态的多选示例。
<template>
<a-select
mode="multiple"
label-in-value
v-model:value="value"
placeholder="Select users"
style="width: 100%"
:filter-option="false"
:not-found-content="fetching ? undefined : null"
@search="fetchUser"
>
<template v-if="fetching" #notFoundContent>
<a-spin size="small" />
</template>
<a-select-option v-for="d in data" :key="d.value">
{{ d.text }}
</a-select-option>
</a-select>
</template>
<script>
import { defineComponent, reactive, toRefs, watch } from 'vue';
import { debounce } from 'lodash-es';
export default defineComponent({
setup() {
let lastFetchId = 0;
const state = reactive({
data: [],
value: [],
fetching: false,
});
const fetchUser = debounce(value => {
console.log('fetching user', value);
lastFetchId += 1;
const fetchId = lastFetchId;
state.data = [];
state.fetching = true;
fetch('https://randomuser.me/api/?results=5')
.then(response => response.json())
.then(body => {
if (fetchId !== lastFetchId) {
// for fetch callback order
return;
}
const data = body.results.map(user => ({
text: `${user.name.first} ${user.name.last}`,
value: user.login.username,
}));
state.data = data;
state.fetching = false;
});
}, 800);
watch(state.value, () => {
state.data = [];
state.fetching = false;
});
return {
...toRefs(state),
fetchUser,
};
},
});
</script>
隐藏下拉列表中已选择的选项。
<template>
<a-select
mode="multiple"
placeholder="Inserted are removed"
v-model:value="selectedItems"
style="width: 100%"
>
<a-select-option v-for="item in filteredOptions" :key="item" :value="item">
{{ item }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { computed, defineComponent, ref } from 'vue';
const OPTIONS = ['Apples', 'Nails', 'Bananas', 'Helicopters'];
export default defineComponent({
setup() {
const selectedItems = ref<string[]>([]);
const filteredOptions = computed(() => OPTIONS.filter(o => !selectedItems.value.includes(o)));
return {
selectedItems,
filteredOptions,
};
},
});
</script>
使用 optionLabelProp
指定回填到选择框的 Option
属性。
<template>
<a-select
v-model:value="value"
mode="multiple"
style="width: 100%"
placeholder="select one country"
option-label-prop="label"
>
<a-select-option value="china" label="China">
<span role="img" aria-label="China">🇨🇳</span>
China (中国)
</a-select-option>
<a-select-option value="usa" label="USA">
<span role="img" aria-label="USA">🇺🇸</span>
USA (美国)
</a-select-option>
<a-select-option value="japan" label="Japan">
<span role="img" aria-label="Japan">🇯🇵</span>
Japan (日本)
</a-select-option>
<a-select-option value="korea" label="Korea">
<span role="img" aria-label="Korea">🇰🇷</span>
Korea (韩国)
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref, watch } from 'vue';
export default defineComponent({
setup() {
const value = ref(['china']);
watch(value, val => {
console.log(`selected:`, val);
});
return {
value,
};
},
});
</script>
三种大小的选择框,当 size 分别为 large
和 small
时,输入框高度为 40px
和 24px
,默认高度为 32px
。
<template>
<a-radio-group v-model:value="size">
<a-radio-button value="large">Large</a-radio-button>
<a-radio-button value="default">Default</a-radio-button>
<a-radio-button value="small">Small</a-radio-button>
</a-radio-group>
<br />
<br />
<a-select :size="size" v-model:value="value1" style="width: 200px">
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
<br />
<a-select
mode="multiple"
:size="size"
placeholder="Please select"
v-model:value="value2"
style="width: 200px"
@popupScroll="popupScroll"
>
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
<br />
<a-select
mode="tags"
:size="size"
placeholder="Please select"
v-model:value="value3"
style="width: 200px"
>
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const popupScroll = () => {
console.log('popupScroll');
};
return {
popupScroll,
size: ref('default'),
value1: ref('a1'),
value2: ref(['a1', 'b2']),
value3: ref(['a1', 'b2']),
};
},
});
</script>
试下复制 露西,杰克
到输入框里。只在 tags 和 multiple 模式下可用。
<template>
<a-select
v-model:value="value"
mode="tags"
style="width: 100%"
:token-separators="[',']"
@change="handleChange"
>
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
return {
handleChange,
value: ref<string[]>([]),
};
},
});
</script>
多选,从已有条目中选择(scroll the menu)
<template>
<a-select
mode="multiple"
v-model:value="value"
style="width: 100%"
placeholder="Please select"
@change="handleChange"
>
<a-select-option v-for="i in 25" :key="(i + 9).toString(36) + i">
{{ (i + 9).toString(36) + i }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const handleChange = (value: string[]) => {
console.log(`selected ${value}`);
};
return {
handleChange,
value: ref(['a1', 'b2']),
};
},
});
</script>
用 OptGroup
进行选项分组。
<template>
<a-select v-model:value="value" style="width: 200px" @change="handleChange">
<a-select-opt-group>
<template #label>
<span>
<user-outlined />
Manager
</span>
</template>
<a-select-option value="jack">Jack</a-select-option>
<a-select-option value="lucy">Lucy</a-select-option>
</a-select-opt-group>
<a-select-opt-group label="Engineer">
<a-select-option value="Yiminghe">yiminghe</a-select-option>
<a-select-option value="Yiminghe1">yiminghe1</a-select-option>
</a-select-opt-group>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
import { UserOutlined } from '@ant-design/icons-vue';
export default defineComponent({
setup() {
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
return {
value: ref(['lucy']),
handleChange,
};
},
components: {
UserOutlined,
},
});
</script>
展开后可对选项进行搜索。
<template>
<a-select
v-model:value="value"
show-search
placeholder="Select a person"
option-filter-prop="children"
style="width: 200px"
:filter-option="filterOption"
@focus="handleFocus"
@blur="handleBlur"
@change="handleChange"
>
<a-select-option value="jack">Jack</a-select-option>
<a-select-option value="lucy">Lucy</a-select-option>
<a-select-option value="tom">Tom</a-select-option>
</a-select>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
const handleBlur = () => {
console.log('blur');
};
const handleFocus = () => {
console.log('focus');
};
const filterOption = (input: string, option: any) => {
return option.props.value.toLowerCase().indexOf(input.toLowerCase()) >= 0;
};
return {
value: ref<string | undefined>(undefined),
filterOption,
handleBlur,
handleFocus,
handleChange,
};
},
});
</script>
基本使用。
<template>
<a-select v-model:value="value1" style="width: 120px" @change="handleChange">
<template #suffixIcon><smile-outlined /></template>
<a-select-option value="jack">Jack</a-select-option>
<a-select-option value="lucy">Lucy</a-select-option>
<a-select-option value="disabled" disabled>Disabled</a-select-option>
<a-select-option value="Yiminghe">yiminghe</a-select-option>
</a-select>
<a-select v-model:value="value2" style="width: 120px" disabled>
<template #suffixIcon><meh-outlined /></template>
<a-select-option value="lucy">Lucy</a-select-option>
</a-select>
</template>
<script lang="ts">
import { SmileOutlined, MehOutlined } from '@ant-design/icons-vue';
import { defineComponent, ref } from 'vue';
export default defineComponent({
setup() {
const handleChange = (value: string) => {
console.log(`selected ${value}`);
};
return {
handleChange,
value1: ref('lucy'),
value2: ref('lucy'),
};
},
components: {
SmileOutlined,
MehOutlined,
},
});
</script>
使用 dropdownRender
对下拉菜单进行自由扩展。
<template>
<a-select v-model:value="value" style="width: 120px">
<template #dropdownRender="{ menuNode: menu }">
<v-nodes :vnodes="menu" />
<a-divider style="margin: 4px 0" />
<div
style="padding: 4px 8px; cursor: pointer"
@mousedown="e => e.preventDefault()"
@click="addItem"
>
<plus-outlined />
Add item
</div>
</template>
<a-select-option v-for="item in items" :key="item" :value="item">
{{ item }}
</a-select-option>
</a-select>
</template>
<script lang="ts">
import { PlusOutlined } from '@ant-design/icons-vue';
import { defineComponent, ref } from 'vue';
let index = 0;
export default defineComponent({
setup() {
const items = ref(['jack', 'lucy']);
const value = ref('lucy');
const addItem = () => {
console.log('addItem');
items.value.push(`New item ${index++}`);
};
return {
items,
value,
addItem,
};
},
components: {
PlusOutlined,
VNodes: (_, { attrs }) => {
return attrs.vnodes;
},
},
});
</script>
10000 Items
Select 使用了虚拟滚动技术,因而获得了比 1.x 更好的性能
<template>
<h2>{{ options.length }} Items</h2>
<a-select
v-model:value="value"
mode="multiple"
style="width: 100%"
placeholder="Please select"
:options="options"
/>
</template>
<script lang="ts">
import { defineComponent, reactive } from 'vue';
const options: { value: string; disabled: boolean }[] = [];
for (let i = 0; i < 10000; i++) {
const value = `${i.toString(36)}${i}`;
options.push({
value,
disabled: i === 10,
});
}
export default defineComponent({
setup() {
const state = reactive({
options,
value: ['a10', 'c12'],
});
return state;
},
});
</script>
API
<a-select>
<a-select-option value="lucy">lucy</a-select-option>
</a-select>
Select props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
allowClear | 支持清除 | boolean | false |
autoClearSearchValue | 是否在选中项后清空搜索框,只在 mode 为 multiple 或 tags 时有效。 | boolean | true |
autofocus | 默认获取焦点 | boolean | false |
defaultActiveFirstOption | 是否默认高亮第一个选项。 | boolean | true |
disabled | 是否禁用 | boolean | false |
dropdownClassName | 下拉菜单的 className 属性 | string | - |
dropdownMatchSelectWidth | 下拉菜单和选择器同宽 | boolean | true |
dropdownRender | 自定义下拉框内容 | ({menuNode: VNode, props}) => VNode | v-slot | - |
dropdownStyle | 下拉菜单的 style 属性 | object | - |
dropdownMenuStyle | dropdown 菜单自定义样式 | object | - |
filterOption | 是否根据输入项进行筛选。当其为一个函数时,会接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true ,反之则返回 false 。 | boolean or function(inputValue, option) | true |
firstActiveValue | 默认高亮的选项 | string|string[] | - |
getPopupContainer | 菜单渲染父节点。默认渲染到 body 上,如果你遇到菜单滚动定位问题,试试修改为滚动的区域,并相对其定位。 | Function(triggerNode) | () => document.body |
labelInValue | 是否把每个选项的 label 包装到 value 中,会把 Select 的 value 类型从 string 变为 {key: string, label: vNodes} 的格式 | boolean | false |
maxTagCount | 最多显示多少个 tag | number | - |
maxTagPlaceholder | 隐藏 tag 时显示的内容 | slot/function(omittedValues) | - |
maxTagTextLength | 最大显示的 tag 文本长度 | number | - |
mode | 设置 Select 的模式为多选或标签 | ‘default’ | ‘multiple’ | ‘tags’ | ‘combobox’ | - |
notFoundContent | 当下拉列表为空时显示的内容 | string|slot | ‘Not Found’ |
optionFilterProp | 搜索时过滤对应的 option 属性,不支持 children | string | value |
optionLabelProp | 回填到选择框的 Option 的属性值,默认是 Option 的子元素。比如在子元素需要高亮效果时,此值可以设为 value 。 | string | children (combobox 模式下为 value ) |
placeholder | 选择框默认文字 | string|slot | - |
showSearch | 使单选模式可搜索 | boolean | false |
showArrow | 是否显示下拉小箭头 | boolean | true |
size | 选择框大小,可选 large small | string | default |
suffixIcon | 自定义的选择框后缀图标 | VNode | slot | - |
removeIcon | 自定义的多选框清除图标 | VNode | slot | - |
clearIcon | 自定义的多选框清空图标 | VNode | slot | - |
menuItemSelectedIcon | 自定义当前选中的条目图标 | VNode | slot | - |
tokenSeparators | 在 tags 和 multiple 模式下自动分词的分隔符 | string[] | |
value(v-model) | 指定当前选中的条目 | string|string[]|number|number[] | - |
options | options 数据,如果设置则不需要手动构造 selectOption 节点 | array<{value, label, [disabled, key, title]}> | [] |
defaultOpen | 是否默认展开下拉菜单 | boolean | - |
open | 是否展开下拉菜单 | boolean | - |
注意,如果发现下拉菜单跟随页面滚动,或者需要在其他弹层中触发 Select,请尝试使用
getPopupContainer={triggerNode => triggerNode.parentNode}
将下拉弹层渲染节点固定在触发器的父元素中。
事件
事件名称 | 说明 | 回调参数 |
---|---|---|
blur | 失去焦点的时回调 | function |
change | 选中 option,或 input 的 value 变化(combobox 模式下)时,调用此函数 | function(value, option:Option/Array<Option>) |
deselect | 取消选中时调用,参数为选中项的 value (或 key) 值,仅在 multiple 或 tags 模式下生效 | function(value,option:Option) |
focus | 获得焦点时回调 | function |
inputKeydown | 键盘按下时回调 | function |
mouseenter | 鼠标移入时回调 | function |
mouseleave | 鼠标移出时回调 | function |
popupScroll | 下拉列表滚动时的回调 | function |
search | 文本框值变化时回调 | function(value: string) |
select | 被选中时调用,参数为选中项的 value (或 key) 值 | function(value, option:Option) |
dropdownVisibleChange | 展开下拉菜单的回调 | function(open) |
Select Methods
名称 | 说明 |
---|---|
blur() | 取消焦点 |
focus() | 获取焦点 |
Option props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
disabled | 是否禁用 | boolean | false |
key | 和 value 含义一致。如果 Vue 需要你设置此项,此项值与 value 的值相同,然后可以省略 value 设置 | string | |
title | 选中该 Option 后,Select 的 title | string | - |
value | 默认根据此属性值进行筛选 | string|number | - |
class | Option 器类名 | string | - |
OptGroup props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
key | string | - | |
label | 组名 | string||function(h)|slot | 无 |
FAQ
点击 dropdownRender
里的内容浮层关闭怎么办?
看下 dropdownRender 例子 里的说明。