跳到主要内容

Transfer 穿梭框 ​

uni-appH5微信小程序App

穿梭框。上下双栏列表(移动端优先的竖排布局),通过勾选与中间操作按钮在两侧之间移动数据项,支持搜索过滤与禁用项。列表使用 scroll-view 滚动,操作箭头使用 base64 <image>,不依赖 DOM API。

何时使用 ​

需要在两个集合之间批量转移条目且要求明确展示可选/已选全貌时,如权限分配、成员挑选。

何时不使用 ​

选项很少(< 5)用 Checkbox 组;单选或简单多选用 Select。

本文档为 uni-app 端组件契约;Web 端同名组件 API 可能略有差异,请以对应包文档为准。下方手机预览实时运行 uni-app H5 演示。

9:41
Transfer 穿梭框 · uni-app H5 实时运行 新窗口打开

Props ​

名称类型默认值说明
modelValuearray"[]"右侧(目标列表)已选 keys,对应 v-model
dataarray"[]"全部数据项:{ key: string|number; label: string; disabled?: boolean }[]
titles[string, string]"['源列表', '目标列表']"上下两个面板的标题(对应 Web 版左右面板标题)
filterablebooleanfalse在头部下方显示搜索框,按 label 包含过滤
placeholderstring"输入关键词搜索"搜索框占位文案

Events ​

名称载荷说明
update:modelValue(string|number)[]移动后触发,携带最新的目标列表已选 keys
change(keys: (string|number)[], direction: 'left'|'right')移动后触发,direction 与 Web 版保持一致:right 移入目标列表、left 移回源列表

示例 ​

基础用法 ​

vue
<Transfer v-model="s" :data="transferData" />

可搜索 ​

vue
<Transfer v-model="s2" :data="transferData" filterable :titles="['全部模块', '已启用']" />

默认已选 ​

vue
<Transfer :model-value="['a', 'b']" :data="transferData" />