Transfer 穿梭框
基础用法
可筛选
您可以在其中搜索和过滤数据项。
可自定义
您可以自定义列表标题、按钮文本、数据项的渲染函数、列表页脚中的选中状态文本以及列表页脚内容。
自定义空数据内容 2.9.0
您可以自定义列表为空或没有筛选结果时显示的内容。
Prop 别名
默认情况下,Transfer 组件会从数据项中寻找 key、label 和 disabled 属性。 如果您的数据项的属性名不同,您可以使用 props 属性来定义别名。
Transfer API
Transfer 属性
| 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| model-value / v-model | 绑定值 | object | [] |
| data | 数据源 | object | [] |
| filterable | Transfer 是否可筛选 | boolean | false |
| filter-placeholder | 筛选输入框的占位符 | string | — |
| filter-method | 自定义筛选方法 | Function | — |
| target-order | 右侧列表元素的排序策略。 如果设置为 original,则元素将保持与数据源相同的顺序。 如果设置为 push,新添加的元素将被推到底部。 如果设置为 unshift,新添加的元素将插入顶部 | 枚举 | original |
| titles | 自定义列表标题 | object | [] |
| button-texts | 自定义按钮文本 | object | [] |
| render-content | 自定义数据项渲染函数 | object | — |
| format | 列表标题中选中状态的文本 | object | {} |
| props | 数据源的 prop 别名 | object | — |
| left-default-checked | 左侧列表初始选中数据项的 key 数组 | object | [] |
| right-default-checked | 右侧列表初始选中数据项的 key 数组 | object | [] |
| validate-event | 是否触发表单验证 | boolean | true |
Transfer 事件
| 名称 | 描述 | 类型 |
|---|---|---|
| change | 右侧列表中的数据项发生改变时触发 | Function |
| left-check-change | 当用户更改左侧列表中任何数据项的选中状态时触发 | Function |
| right-check-change | 当用户更改右侧列表中任何数据项的选中状态时触发 | Function |
Transfer 插槽
| 名称 | 描述 | 类型 |
|---|---|---|
| default | 数据项的自定义内容。 | object |
| left-footer | 左侧列表底部的内容 | — |
| right-footer | 右侧列表底部的内容 | — |
| left-empty 2.9.0 | 当左侧面板为空或没有数据匹配筛选器时显示的内容 | — |
| right-empty 2.9.0 | 当右侧面板为空或没有数据匹配筛选器时显示的内容 | — |
Transfer Exposes
| 名称 | 描述 | 类型 |
|---|---|---|
| clearQuery | 清除某个面板的筛选关键字 | Function |
| leftPanel | 左侧面板 ref | object |
| rightPanel | 右侧面板 ref | object |
Transfer Panel API
Transfer Panel Exposes
| 名称 | 描述 | 类型 |
|---|---|---|
| query | 筛选关键字 | string |
类型声明
显示声明
ts
import type { h as H, VNode } from 'vue'
type TransferKey = string | number
type TransferDirection = 'left' | 'right'
type TransferDataItem = Record<string, any>
type renderContent = (h: typeof H, option: TransferDataItem) => VNode | VNode[]
interface TransferFormat {
noChecked?: string
hasChecked?: string
}
interface TransferPropsAlias {
label?: string
key?: string
disabled?: string
}