Multi Select
在可搜索控件中选择多个选项,并管理生成的标签。
适用场景
- 当界面需要以下行为时使用 Multi Select:在可搜索控件中选择多个选项,并管理生成的标签。
安装
选择安装方式,用法示例将同步更新导入路径。
$ bunx --bun shadcn-vue@2.8.2 add https://orvui.efu.me/r/multi-select.json
首次使用时,将安装的 src/components/orvui/styles.css 导入项目样式入口。
示例
预览
designengineering
packages/vue/src/motion/multi-select/demo.vue
<script setup lang="ts">
import { ref } from "vue";
import { Circle } from "lucide-vue-next";
import {
MultiSelect,
MultiSelectTrigger,
MultiSelectValue,
MultiSelectInput,
MultiSelectContent,
MultiSelectList,
MultiSelectGroup,
MultiSelectLabel,
MultiSelectItem,
MultiSelectEmpty,
} from "@/components/orvui/motion/multi-select";
const selected = ref(["design", "engineering"]);
const groups = [
{
label: "Product teams",
items: [
{
value: "design",
label: "Design",
color: "fill-rose-500 text-rose-500",
},
{
value: "engineering",
label: "Engineering",
color: "fill-sky-500 text-sky-500",
},
{
value: "product",
label: "Product",
color: "fill-amber-500 text-amber-500",
},
{
value: "research",
label: "Research",
color: "fill-violet-500 text-violet-500",
},
],
},
{
label: "Business teams",
items: [
{
value: "marketing",
label: "Marketing",
color: "fill-emerald-500 text-emerald-500",
},
{
value: "operations",
label: "Operations",
color: "fill-slate-500 text-slate-500",
},
],
},
];
</script>
<template>
<div class="flex min-h-[420px] w-full items-start justify-center px-4 pt-24">
<div class="w-full max-w-sm">
<MultiSelect v-model="selected"
><MultiSelectTrigger
><MultiSelectValue placeholder="Choose teams" /><MultiSelectInput
aria-label="Search teams" /></MultiSelectTrigger
><MultiSelectContent
><MultiSelectList aria-label="Teams"
><MultiSelectGroup v-for="group in groups" :key="group.label"
><MultiSelectLabel>{{ group.label }}</MultiSelectLabel
><MultiSelectItem
v-for="team in group.items"
:key="team.value"
:value="team.value"
:text-value="team.label"
><span class="flex items-center gap-2.5"
><Circle
aria-hidden="true"
:class="['size-2.5', team.color]"
/>{{ team.label }}</span
></MultiSelectItem
></MultiSelectGroup
><MultiSelectEmpty
>No teams found.</MultiSelectEmpty
></MultiSelectList
></MultiSelectContent
></MultiSelect
>
</div>
</div>
</template>
packages/vue/src/motion/multi-select/src/MultiSelect.vue
状态与事件
需要由表单、路由或父组件管理时,绑定下列状态并接收对应更新。v-model 是属性与 update 事件的简写;值的类型应与 API 一致。
| 组件 | Vue 绑定 | 更新事件 |
|---|---|---|
MultiSelect | v-modelstring[] | update:modelValue |
MultiSelect | v-model:openboolean | update:open |
MultiSelect | v-model:querystring | update:query |
可选受控属性未传入时,按组件文档的默认行为工作;不要用固定的 false 或空值代替未传入。异步请求和持久化在应用中处理,再把结果传回组件。
API 参考
MultiSelect
modelValue?string[]—defaultValue?string[](multiple ? [] : undefined)open?booleanundefineddefaultOpen?booleanfalsequery?string—defaultQuery?string""disabled?booleanfalsefilter?(value: string, query: string, keywords: string[]) => boolean—事件
update:modelValue—@update:modelValuechange—@changeupdate:open—@update:openupdate:query—@update:query插槽
default—作用域参数: value, open, query
#defaultMultiSelectTrigger
插槽
default() => VNodeChild#defaultMultiSelectValue
placeholder?string"Select options"chipClassName?string—插槽
default—作用域参数: value, label
#defaultMultiSelectInput
placeholder?string"Search…"wrapperClassName?string—showIcon?booleanfalseMultiSelectContent
side?"top" | "bottom""bottom"align?"start" | "center" | "end""start"sideOffset?number6avoidCollisions?booleantrue插槽
default() => VNodeChild#defaultMultiSelectList
ariaLabel?string"Options"插槽
default() => VNodeChild#defaultMultiSelectGroup
插槽
default() => VNodeChild#defaultMultiSelectLabel
插槽
default() => VNodeChild#defaultMultiSelectItem
valuestring—textValue?string—label?string—keywords?string[]() => []disabled?booleanfalse事件
select[value: string]@select插槽
default() => VNodeChild#defaultMultiSelectEmpty
插槽
default() => VNodeChild#default无障碍
为交互控件提供明确的无障碍名称。保留文档中的键盘路径、可见焦点与减少动态效果状态;自定义插槽应继续保留所替代部件的语义。
常见问题
- 如何配置 Multi Select?
- 通过字符串数组 modelValue 与 update:modelValue 管理选中值;非受控用法使用 defaultValue。
- 如何连接到应用状态?
- 监听 update:modelValue、change、update:open、update:query,将组件连接到应用状态。
- 可以在服务端渲染吗?
- 可以在 Vue SSR 应用中正常渲染。服务端与客户端的初始 props 应保持一致;浏览器测量与交互资源在挂载后启动。
更新于
来源与许可 ↗MIT · 0.1.1