Skip to content

Select 选择器 ​

当选项过多时,使用下拉菜单展示并选择内容。

提示

el-select 的默认宽度更改为 100%。当使用内联形式时,宽度可能显示异常。为了保持显示正常,您需要手动配置 el-select 的宽度(如: 例子)。

ts
import { createApp } from 'vue'
import { ElSelect } from '@szhn/dh-design-pc'

const app = createApp()
app.use(ElSelect)

基础用法 ​

Options 属性 ​

有禁用选项 ​

禁用状态 ​

禁用整个选择器组件

可清空 ​

您可以使用清除图标来清除选择。

尺寸 ​

基础多选 ​

多选选择器使用 tag 组件来展示已选中的选项。

自定义模板 ​

你可以自定义如何来渲染每一个选项。

自定义下拉菜单的头部 ​

您可以自定义下拉菜单的头部。

自定义下拉菜单的底部 ​

您可以自定义下拉菜单的底部。

将选项进行分组 ​

你可以为选项进行分组来区分不同的选项

筛选选项 ​

可以利用筛选功能快速查找选项。

远程搜索 ​

输入关键字以从远程服务器中查找数据。

创建新的选项 ​

创建并选中未包含在初始选项中的条目。

使用值键 value-key 属性 ​

如果 Select 的绑定值为对象类型,请务必指定 value-key 作为它的唯一性标识。

自定义标签 ​

您可以自定义标签。

自定义加载 ​

修改加载区域内容

空值配置 ​

若想配置如空字符串为有效值而不是空值,可以配置 empty-values 为 [null, undefined].

如果您想要将清空值更改为 null, 请设置 value-on-clear 为 null

自定义标签 ​

您可以自定义标签

Select API ​

Select Attributes ​

属性名说明类型Default
model-value / v-model选中项绑定值string / number / boolean / object / array—
multiple是否多选booleanfalse
options选项的数据源, value 的 key 和 label 和 disabled可以通过 props自定义.array—
propsoptions 的配置object—
disabled是否禁用booleanfalse
value-key作为 value 唯一标识的键名,绑定值为对象类型时必填stringvalue
size输入框尺寸enum—
clearable是否可以清空选项booleanfalse
collapse-tags多选时是否将选中值按文字的形式展示booleanfalse
collapse-tags-tooltip当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。 要使用此属性,collapse-tags属性必须设定为 truebooleanfalse
tag-tooltip折叠标签工具提示的配置对象。 要使用此项, collapse-tags 和 collapse-tags-tooltip 必须为 trueobject{}
multiple-limitmultiple 属性设置为 true 时,代表多选场景下用户最多可以选择的项目数, 为 0 则不限制number0
id原生 input 的 idstring—
nameSelect 输入框的原生 name 属性string—
effecttooltip 主题,内置了 dark / light 两种enum / stringlight
autocompleteSelect 输入框的原生 autocomplete 属性stringoff
placeholder占位符,默认为“Select”string—
filterableSelect 组件是否可筛选booleanfalse
allow-create是否允许用户创建新条目, 当filterable设置为 true 时才会生效booleanfalse
filter-method自定义筛选方法的第一个参数是当前输入的值。 只有当 filterable 设置为 true 时才会生效。Function—
remote其中的选项是否从服务器远程加载booleanfalse
debounce远程搜索时的防抖延迟(以毫秒为单位)number300
remote-method当输入值发生变化时触发的函数。 它的参数就是当前的输入值。 当filterable设置为 true 时才会生效Function—
remote-show-suffix远程搜索方法显示后缀图标booleanfalse
loading是否正在从远程获取数据booleanfalse
loading-text从服务器加载数据时显示的文本,默认为“Loading”string—
no-match-text搜索条件无匹配时显示的文字,也可以使用 empty 插槽设置,默认是 “No matching data'”string—
no-data-text无选项时显示的文字,也可以使用 empty 插槽设置自定义内容,默认是 “No data”string—
popper-class为 Select 下拉菜单和标签提示设置自定义类名string''
popper-style为 Select 下拉菜单和标签提示设置自定义样式string / object—
reserve-keyword当 multiple 和 filterable被设置为 true 时,是否在选中一个选项后保留当前的搜索关键词booleantrue
default-first-option是否在输入框按下回车时,选择第一个匹配项。 需配合 filterable 或 remote 使用booleanfalse
teleported是否使用 teleport。设置成 true则会被追加到 append-to 的位置booleantrue
append-to下拉框挂载到哪个 DOM 元素CSSSelector / HTMLElement—
persistent当下拉选择器未被激活并且persistent设置为false,选择器会被删除。booleantrue
automatic-dropdown对于不可搜索的 Select,是否在输入框获得焦点后自动弹出选项菜单booleanfalse
clear-icon自定义清除图标string / objectCircleClose
fit-input-width下拉框的宽度是否与输入框相同booleanfalse
suffix-icon自定义后缀图标组件string / objectArrowDown
tag-type标签类型enuminfo
tag-effect标签效果enumlight
validate-event是否触发表单验证booleantrue
offset下拉面板偏移量number4
show-arrow下拉菜单的内容是否有箭头booleanfalse
placement下拉框出现的位置enumbottom-start
fallback-placementsdropdown 可用的 positions 请查看popper.js 文档array['bottom-start', 'top-start', 'right', 'left']
max-collapse-tags需要显示的 Tag 的最大数量 只有当 collapse-tags 设置为 true 时才会生效。number1
popper-optionspopper.js 参数object{}
aria-label a11y等价于原生 input aria-label 属性string—
empty-values组件的空值配置, 参考config-providerarray—
value-on-clear清空选项的值, 参考config-providerstring / number / boolean / Function—
suffix-transition deprecated下拉菜单显示/消失时后缀图标的动画booleantrue
tabindexinput 的 tabindexstring / number—

注意

suffix-transition 已被 弃用,之后将会被删除,请使用覆盖样式方案。

Props ​

Attribute说明TypeDefault
value指定选项的值为选项对象的某个属性值stringvalue
label指定节点标签为节点对象的某个属性值stringlabel
options指定选项的子选项为选项对象的某个属性值stringoptions
disabled指定选项的禁用为选项对象的某个属性值stringdisabled

tag-tooltip ​

标签工具提示中的属性遵循此优先级顺序:

  1. 在标签工具提示对象中明确定义的字段。
  2. 从 el-select 继承的共享属性(例如 effect、popper-class、popper-style、teleported、append-to、popper-options)。
  3. 底层 el-tooltip 组件的默认值。 这样,您就可以覆盖标签的特定工具提示行为,同时保持与默认的“选择”下拉菜单的一致性。
属性说明类型默认值
append-to指示 Tooltip 的内容将附加在哪一个网页元素上CSSSelector / HTMLElement—
placementTooltip 组件出现的位置enumbottom
fallback-placementsTooltip 可用的 positions 请查看popper.js 文档array['bottom', 'top', 'right', 'left']
effect文字提示(Tooltip)的主题,内置dark和light两种。enum / string—
popper-class为 Tooltip 的 popper 添加自定义类名string—
popper-style为 Tooltip 的 popper 添加自定义样式string / object—
transitionTooltip 所应用过渡动画的名称string—
teleported是否使用 teleport。设置成 true则会被追加到 append-to 的位置boolean—
popper-optionspopper.js 参数object—
show-after在触发后多久显示内容,单位毫秒number—
hide-after关闭时的延迟number—
auto-closetooltip 出现后自动隐藏延时,单位毫秒number—
offsetTooltip 出现位置的偏移量number—

Select Events ​

事件名说明Type
change选中值发生变化时触发Function
visible-change下拉框出现/隐藏时触发Function
remove-tag多选模式下移除tag时触发Function
clear可清空的单选模式下用户点击清空按钮时触发Function
blur当 input 失去焦点时触发Function
focus当 input 获得焦点时触发Function
popup-scroll下拉滚动时触发Function

Select Slots ​

插槽名说明子标签
defaultoption 组件列表Option Group / Option
header下拉列表顶部的内容—
footer下拉列表底部的内容—
prefixSelect 组件头部内容—
empty无选项时的列表—
tag作为 Select 组件的内容时,子标签支持 data、selectDisabled 和 deleteTag。object
loadingselect 组件自定义 loading内容—
labelselect 组件自定义标签内容,支持 index。object

Select Exposes ​

方法名详情类型
focus使选择器的输入框获取焦点Function
blur使选择器的输入框失去焦点,并隐藏下拉框Function
selectedLabel获取当前选中的标签object

Option Group API ​

Option Group Attributes ​

名称详情类型默认值
label分组的名称string—
disabled是否将该分组下所有选项置为禁用booleanfalse

Option Group Slots ​

插槽名说明Subtags
default自定义默认内容Option

Option API ​

Option Attributes ​

Name描述类型默认值
value选项的值string / number / boolean / object—
label选项的标签,若不设置则默认与value相同string / number—
disabled是否禁用该选项booleanfalse

Option Slots ​

名称说明
default默认插槽内容