Skip to content

Select 选择器

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

基础用法

有禁用选项

禁用状态

可清空单选

基础多选

自定义模板

将选项进行分组

筛选选项

远程搜索

创建新的选项

API

Select 属性

参数说明类型可选值默认值
model-value / v-model选中项绑定值enum--
multiple是否多选booleantrue/falsefalse
disabled是否禁用booleantrue/falsefalse
value-key作为 value 唯一标识的键名,绑定值为对象类型时必填string-value
size输入框尺寸stringenumsmall
clearable是否可以清空选项booleantrue / falsefalse
collapse-tags多选时是否将选中值按文字的形式展示booleantrue / falsefalse
collapse-tags-tooltip当鼠标悬停于折叠标签的文本时,是否显示所有选中的标签。 要使用此属性,collapse-tags属性必须设定为 truebooleantrue / falsefalse
multiple-limitmultiple 属性设置为 true 时,代表多选场景下用户最多可以选择的项目数, 为 0 则不限制number-0
nameSelect 输入框的原生 name 属性string--
themeTooltip 主题,内置了 dark / light 两种stringdark / lightlight
autocompleteSelect 输入框的原生 autocomplete 属性string-off
placeholder占位文字string-Select
filterableSelect 组件是否可筛选booleantrue / falsefalse
allow-create是否允许用户创建新条目, 只有当 filterable 设置为 true 时才会生效。booleantrue / falsefalse
filter-method自定义筛选方法function--
remote其中的选项是否从服务器远程加载booleantrue / falsefalse
remote-method自定义远程搜索方法function--
remote-show-suffix远程搜索方法显示后缀图标booleantrue / falsefalse
loading是否正在从远程获取数据booleantrue / falsefalse
loading-text从服务器加载内容时显示的文本string-Loading
no-match-text搜索条件无匹配时显示的文字,也可以使用 empty 插槽设置string-No matching data
no-data-text无选项时显示的文字,也可以使用 empty 插槽设置自定义内容string-No data
popper-class选择器下拉菜单的自定义类名string--
reserve-keyword当 multiple 和 filter 被设置为 true 时,是否在选中一个选项后保留当前的搜索关键词booleantrue / falsetrue
default-first-option是否在输入框按下回车时,选择第一个匹配项。 需配合 filterable 或 remote 使用booleantrue / falsefalse
teleport该下拉菜单使用 teleport 插入元素string-body
persistent当下拉选择器未被激活并且 persistent 设置为 false,选择器会被删除。booleantrue / falsetrue
automatic-dropdown对于不可过滤的 Select 组件,此属性决定是否在输入框获得焦点后自动弹出选项菜单booleantrue / falsefalse
clear-icon自定义清除图标string | Component-CircleClose
fit-input-width下拉框的宽度是否与输入框相同booleantrue / falsefalse
suffix-icon自定义后缀图标组件string | Component-ArrowDown
tag-type标签类型stringenuminfo
validate-event是否触发表单验证booleantrue / falsetrue
placement下拉框出现的位置stringenumbottom

Select 事件

事件名说明回调参数
change选中值发生变化时触发val,目前的选中值
visible-change下拉框出现/隐藏时触发val,出现则为 true,隐藏则为 false
remove-tag多选模式下移除 tag 时触发val,移除的tag值
clear可清空的单选模式下用户点击清空按钮时触发
blur当 input 失去焦点时触发(event: FocusEvent)
focus当 input 获得焦点时触发(event: FocusEvent)

Select 插槽

名称说明参数
defaultOption 组件列表Option Group / Option
prefixSelect 组件头部内容-
empty无选项时的列表-

Option Group 属性

参数说明类型可选值默认值
label分组的组名string--
disabled是否将该分组下所有选项置为禁用boolean-false

Option Group 插槽

名称说明参数
default自定义默认内容Option

Option 属性

参数说明类型可选值默认值
value选项的值string / number / boolean / object--
label选项的标签,若不设置则默认与 value 相同string/number--
disabled是否禁用该选项boolean-false

Option 插槽

名称说明参数
default默认插槽-

Select 方法

名称说明参数
focus使选择器的输入框获取焦点-
blur使选择器的输入框失去焦点,并隐藏下拉框-

类型定义

组件导出以下类型定义:

ts
import type { SelectTheme, SelectThemeVars, SelectPlacement } from 'ryxon'

主题定制

样式变量

组件提供了下列 CSS 变量,可用于自定义样式,使用方法请参考 ConfigProvider 组件

名称默认值描述
--r-select-height24pxselect 高度
--r-select-font-sizevar(--r-font-size-md)-
--r-select-input-colorvar(--r-text-color-placeholder)-
--r-select-input-font-size14px-
--r-select-border-color-hovervar(--r-border-color-hover)-
--r-select-disabled-bordervar(--r-disabled-border-color)-
--r-select-close-hover-colorvar(--r-text-color-secondary)-
--r-select-multiple-input-colorvar(--r-text-color-regular)-

Released under the MIT License.