Transfer 穿梭框

基础用法

Transfer 的数据通过 data 属性传入。 数据需要是一个对象数组,每个对象有以下属性:key 为数据的唯一性标识,label 为显示文本,disabled 表示该项数据是否禁止被操作。 目标列表中的数据项会同步到绑定至 v-model 的变量,值为数据项的 key 所组成的数组。 当然,如果希望在初始状态时目标列表不为空,可以像本例一样为 v-model 绑定的变量赋予一个初始值。

No data

可搜索过滤

在数据很多的情况下,可以对数据进行搜索和过滤。

设置 filterabletrue 即可开启搜索模式。 默认情况下,若数据项的 label 属性包含搜索关键字,则会在搜索结果中显示。 你也可以使用 filter-method 定义自己的搜索逻辑。 filter-method 接收一个方法,当搜索关键字变化时,会将当前的关键字和每个数据项传给该方法。 若方法返回 true,则会在搜索结果中显示对应的数据项。

No data

自定义

可以对列表标题文案、按钮文案、数据项的渲染函数、列表底部的勾选状态文案、列表底部的内容区等进行自定义。

可以使用 titlesbutton-textsrender-contentformat 属性分别对列表标题文案、按钮文案、数据项的渲染函数和列表顶部的勾选状态文案进行自定义。 数据项的渲染还可以使用 scoped-slot 进行自定义。 对于列表底部的内容区,提供了两个具名 slot:left-footerright-footer。 此外,如果希望某些数据项在初始化时就被勾选,可以使用 left-default-checkedright-default-checked 属性。 最后,本例还展示了 change 事件的用法。 注意,由于 JSFiddle 不支持 JSX 语法,故该示例无法在 JSFiddle 运行。 但是在实际的项目中,只要正确地配置了相关依赖,就可以正常运行。

Customize data items using render-content

Customize data items using scoped slot

自定义空内容 2.9.0

您可以自定义列表为空或未找到筛选结果时显示的内容。

使用 left-emptyright-empty 插槽来自定义每个面板的空内容。

No data

数据项属性别名

默认情况下,Transfer 仅能识别数据项中的 keylabeldisabled 字段。 如果你的数据的字段名不同,可以使用 props 属性为它们设置别名。

本例中的数据源没有 keylabel 字段,在功能上与它们相同的字段名为 valuedesc。 因此可以使用props 属性为 keylabel 设置别名。

No data

Transfer API

Transfer 属性

属性名说明类型默认值
model-value / v-model选中项绑定值object[]
dataTransfer 的数据源object[]
filterable是否可搜索booleanfalse
filter-placeholder搜索框占位符string
filter-method自定义搜索方法Function
target-order右侧列表元素的排序策略: 若为 original,则保持与数据源相同的顺序; 若为 push,则新加入的元素排在最后; 若为 unshift,则新加入的元素排在最前enumoriginal
titles自定义列表标题object[]
button-texts自定义按钮文案object[]
render-content自定义数据项渲染函数object
format列表顶部勾选状态文案object{}
props数据源的字段别名object
left-default-checked初始状态下左侧列表的已勾选项的 key 数组object[]
right-default-checked初始状态下右侧列表的已勾选项的 key 数组object[]
validate-event是否触发表单验证booleantrue

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左侧面板 refobject
rightPanel右侧面板 refobject

Transfer Panel API

Transfer Panel Exposes

名称描述类型
query过滤关键词string

Type Declarations

Show declarations
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
}

源代码

组件样式文档

贡献者