Combobox

通过输入框筛选分组选项,键盘焦点保持在输入区域。

适用场景

  • 当界面需要以下行为时使用 Combobox:通过输入框筛选分组选项,键盘焦点保持在输入区域。

安装

选择安装方式,用法示例将同步更新导入路径。

$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/combobox.json

首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。

示例

预览

Workspace

组合结构

使用公开部件 Combobox, ComboboxTrigger, ComboboxInput, ComboboxContent, ComboboxList, ComboboxEmpty, ComboboxGroup, ComboboxSeparator, ComboboxLabel, ComboboxItem 组合 Combobox,并从该组件的公开入口导入。

Combobox
├── ComboboxTrigger
│   └── ComboboxInput
└── ComboboxContent
    └── ComboboxList
        ├── ComboboxEmpty
        ├── ComboboxGroup
        │   ├── ComboboxLabel
        │   └── ComboboxItem
        └── ComboboxSeparator

工作方式

通过输入框筛选分组选项,键盘焦点保持在输入区域。

状态与事件

需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。

组件状态绑定
组件Vue 绑定更新事件
Comboboxv-modelstringupdate:modelValue
Comboboxv-model:openbooleanupdate:open
Comboboxv-model:querystringupdate:query

可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。

API 参考

Combobox

modelValue?
string
—
defaultValue?
string
(multiple ? [] : undefined)
open?
boolean
undefined
defaultOpen?
boolean
false
query?
string
—
defaultQuery?
string
""
disabled?
boolean
false
filter?
(value: string, query: string, keywords: string[]) => boolean
—

事件

update:modelValue
—
@update:modelValue
change
—
@change
update:open
—
@update:open
update:query
—
@update:query

插槽

default
—

作用域参数: value, open, query

#default

ComboboxTrigger

插槽

default
() => VNodeChild
#default

ComboboxInput

placeholder?
string
"Search…"
wrapperClassName?
string
—
showIcon?
boolean
true

ComboboxContent

side?
"top" | "bottom"
"bottom"
align?
"start" | "center" | "end"
"start"
sideOffset?
number
6
avoidCollisions?
boolean
true

插槽

default
() => VNodeChild
#default

ComboboxList

ariaLabel?
string
"Options"

插槽

default
() => VNodeChild
#default

ComboboxEmpty

插槽

default
() => VNodeChild
#default

ComboboxGroup

插槽

default
() => VNodeChild
#default

ComboboxLabel

插槽

default
() => VNodeChild
#default

ComboboxItem

value
string
—
textValue?
string
—
label?
string
—
keywords?
string[]
() => []
disabled?
boolean
false

事件

select
[value: string]
@select

插槽

default
() => VNodeChild
#default

无障碍

为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。

常见问题

如何配置 Combobox?
通过 modelValue、defaultValue、open、defaultOpen、query、defaultQuery、disabled、filter 配置 Combobox;API 表列出其类型与默认值。
如何连接到应用状态?
监听 update:modelValue、change、update:open、update:query,将组件连接到应用状态。
可以在服务端渲染吗?
可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。

更新于