Transfer 穿梭框
基础用法
Transfer 的数据通过 data
属性传入。 数据需要是一个对象数组,每个对象有以下属性:key
为数据的唯一性标识,label
为显示文本,disabled
表示该项数据是否禁止被操作。 目标列表中的数据项会同步到绑定至 v-model
的变量,值为数据项的 key
所组成的数组。 当然,如果希望在初始状态时目标列表不为空,可以像本例一样为 v-model
绑定的变量赋予一个初始值。
可搜索过滤
在数据很多的情况下,可以对数据进行搜索和过滤。
设置 filterable
为 true
即可开启搜索模式。 默认情况下,若数据项的 label
属性包含搜索关键字,则会在搜索结果中显示。 你也可以使用 filter-method
定义自己的搜索逻辑。 filter-method
接收一个方法,当搜索关键字变化时,会将当前的关键字和每个数据项传给该方法。 若方法返回 true
,则会在搜索结果中显示对应的数据项。
自定义
可以对列表标题文案、按钮文案、数据项的渲染函数、列表底部的勾选状态文案、列表底部的内容区等进行自定义。
可以使用 titles
、button-texts
、render-content
和 format
属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。 数据项的渲染还可以使用 scoped-slot
进行自定义。 对于列表底部的内容区,提供了两个具名 slot:left-footer
和 right-footer
。 此外,如果希望某些数据项在初始化时就被勾选,可以使用 left-default-checked
和 right-default-checked
属性。 最后,本例还展示了 change
事件的用法。 注意,由于 JSFiddle 不支持 JSX 语法,故该示例无法在 JSFiddle 运行。 但是在实际的项目中,只要正确地配置了相关依赖,就可以正常运行。
自定义空内容 2.9.0
您可以自定义列表为空或未找到筛选结果时显示的内容。
使用 left-empty
和 right-empty
插槽来自定义每个面板的空内容。
数据项属性别名
默认情况下,Transfer 仅能识别数据项中的 key
、label
和 disabled
字段。 如果你的数据的字段名不同,可以使用 props
属性为它们设置别名。
本例中的数据源没有 key
和 label
字段,在功能上与它们相同的字段名为 value
和 desc
。 因此可以使用props
属性为 key
和 label
设置别名。
Transfer API
Transfer 属性
属性名 | 说明 | 类型 | 默认值 |
---|---|---|---|
model-value / v-model | 选中项绑定值 | object | [] |
data | Transfer 的数据源 | object | [] |
filterable | 是否可搜索 | boolean | false |
filter-placeholder | 搜索框占位符 | string | — |
filter-method | 自定义搜索方法 | Function | — |
target-order | 右侧列表元素的排序策略: 若为 original ,则保持与数据源相同的顺序; 若为 push ,则新加入的元素排在最后; 若为 unshift ,则新加入的元素排在最前 | enum | original |
titles | 自定义列表标题 | object | [] |
button-texts | 自定义按钮文案 | object | [] |
render-content | 自定义数据项渲染函数 | object | — |
format | 列表顶部勾选状态文案 | object | {} |
props | 数据源的字段别名 | 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 Slots
插槽名 | 说明 |
---|---|
default | 自定义数据项的内容, 参数为 { option } |
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 |
Type Declarations
Show declarations
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
}