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 运行。 但是在实际的项目中，只要正确地配置了相关依赖，就可以正常运行。

数据项属性别名

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

本例中的数据源没有 key 和 label 字段，在功能上与它们相同的字段名为 value 和 desc。 因此可以使用props 属性为 key 和 label 设置别名。

拖拽排序

Transfer 支持拖拽排序。 开启拖拽排序需要设置 drag 为 true。 也可以使用drag-icon更换拖拽图标。

API

Transfer Props

参数名	描述	类型	默认值
v-model / modelValue	绑定的数据	object	[]
data	transfer数据源	any[]	[]
filterable	是否可搜索	boolean	false
filter-placeholder	搜索占位符	string	-
target-order	右侧列表元素的排序策略：若为original，则保持与数据源相同的顺序；若为push，则新加入的元素排在最后；若为unshift，则新加入的元素排在最前	enum	original
titles	左右两侧标题	array	[]
button-texts	按钮文案	array	[]
drag	是否可拖拽排序	boolean	false
drag-icon	自定义拖拽图标	string | Component	-
render-content	自定义渲染函数	object	-
format	列表顶部勾选状态文案	object	{}
props	数据源的字段别名	object	[]
left-default-checked	默认左侧勾选数据项	object	[]
right-default-checked	默认右侧勾选数据项	object	[]
validate-event	是否触发表单验证	boolean	true

Transfer Events

事件名	描述	类型
change	右侧列表元素变化时触发	Function
left-check-change	左侧列表元素选中时触发	Function
right-check-change	右侧列表元素选中时触发	Function
reset	重置为默认数据时触发	Function
sort	拖拽排序时触发	Function

Transfer Methods

方法名	描述	类型
clearQuery	清空搜索框内容	Function

Transfer Slots

插槽名	描述	参数
default	自定义数据项的内容， 参数为	-
left-footer	自定义左侧列表底部内容	-
right-footer	自定义右侧列表底部内容	-
left-empty	自定义左侧列表为空时的内容	-
right-empty	自定义右侧列表为空时的内容	-