Transfer 穿梭框
规则
js
{
type:"aTransfer",
title:"树形选择",
field:"transfer",
modelField:"selectedKeys",
value:[],
props:{
titles:['Source', 'Target'],
render: (item) => item.label
dataSource:[{
value: 'beijing',
label: '北京',
children: [
{
value: 'gugong',
label: '故宫'
},
{
value: 'tiantan',
label: '天坛'
},
{
value: 'wangfujing',
label: '王府井'
}
]
}, {
value: 'jiangsu',
label: '江苏',
children: [
{
value: 'nanjing',
label: '南京',
children: [
{
value: 'fuzimiao',
label: '夫子庙',
}
]
},
{
value: 'suzhou',
label: '苏州',
children: [
{
value: 'zhuozhengyuan',
label: '拙政园',
},
{
value: 'shizilin',
label: '狮子林',
}
]
}
]
}]
}
}
完整配置项:Ant-design-vue_Transfer
Props
参数 | 说明 | 类型 | 默认值 |
---|---|---|---|
dataSource | 数据源,其中的数据将会被渲染到左边一栏中,targetKeys 中指定的除外。 | [{key: string.isRequired,title: string.isRequired,description: string,disabled: bool}][] | [] |
disabled | 是否禁用 | boolean | false |
filterOption | 接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true ,反之则返回 false 。 | (inputValue, option): boolean | |
footer | 可以设置为一个 作用域插槽 | slot="footer" slot-scope="props" | |
listStyle | 两个穿梭框的自定义样式 | CSSProperties | |
locale | 各种语言 | object | { itemUnit: '项', itemsUnit: '项', notFoundContent: '列表为空', searchPlaceholder: '请输入搜索内容' } |
oneWay | 展示为单向样式 | boolean | false |
operations | 操作文案集合,顺序从上至下 | string[] | ['>', '<'] |
operationStyle | 操作栏的自定义样式 | CSSProperties | - |
pagination | 使用分页样式,自定义渲染列表下无效 | boolean | { pageSize: number, simple: boolean, showSizeChanger?: boolean, showLessItems?: boolean } | flase |
render | 每行数据渲染函数,该函数的入参为 dataSource 中的项,返回值为 element。或者返回一个普通对象,其中 label 字段为 element,value 字段为 title | Function(record)| slot | |
selectAllLabels | 自定义顶部多选框标题的集合 | VueNode | ((info: { selectedCount: number; totalCount: number }) => VueNode) | - |
selectedKeys(v-model) | 设置哪些项应该被选中 | string[] | [] |
showSearch | 是否显示搜索框 | boolean | false |
showSelectAll | 是否展示全选勾选框 | boolean | true |
status | 设置校验状态 | 'error' | 'warning' | - |
targetKeys(v-model) | 显示在右侧框数据的 key 集合 | string[] | [] |
titles | 标题集合,顺序从左至右 | string[] | ['', ''] |
Events
事件名称 | 说明 | 回调参数 |
---|---|---|
change | 选项在两栏之间转移时的回调函数 | (targetKeys, direction, moveKeys): void |
scroll | 选项列表滚动时的回调函数 | (direction, event): void |
search | 搜索框内容时改变时的回调函数 | (direction: 'left'|'right', value: string): void |
selectChange | 选中项发生改变时的回调函数 | (sourceSelectedKeys, targetSelectedKeys): void |
Render Props
Transfer 支持接收 children
自定义渲染列表,并返回以下参数:
json
{
"direction": String,
"disabled": Boolean,
"filteredItems": Array,
"selectedKeys": Array,
"onItemSelect": Function,
"onItemSelectAll": Function
}
参数 | 说明 | 类型 |
---|---|---|
direction | 渲染列表的方向 | 'left' | 'right' |
disabled | 是否禁用列表 | boolean |
filteredItems | 过滤后的数据 | TransferItem[] |
itemSelect | 勾选条目 | (key: string, selected: boolean) |
itemSelectAll | 勾选一组条目 | (keys: string[], selected: boolean) |
selectedKeys | 选中的条目 | string[] |