{
"name": "Transfer",
"props": {
"mode": {
"type": {
"name": "enum",
"value": [
{
"value": "'normal'",
"computed": false
},
{
"value": "'simple'",
"computed": false
}
]
},
"required": false,
"description": "移动选项模式",
"defaultValue": {
"value": "'normal'",
"computed": false
},
"docblock": "移动选项模式"
},
"dataSource": {
"type": {
"name": "arrayOf",
"value": {
"name": "object"
}
},
"required": false,
"description": "数据源",
"defaultValue": {
"value": "[]",
"computed": false
},
"docblock": "数据源"
},
"value": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "（用于受控）当前值",
"docblock": "（用于受控）当前值"
},
"defaultValue": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "（用于非受控）初始值",
"defaultValue": {
"value": "[]",
"computed": false
},
"docblock": "（用于非受控）初始值"
},
"onChange": {
"type": {
"name": "func"
},
"required": false,
"description": "值发生改变的时候触发的回调函数",
"docblock": "值发生改变的时候触发的回调函数\n@param {Array} value 右面板值\n@param {Array} data 右面板数据\n@param {Object} extra 额外参数\n@param {Array} extra.leftValue 左面板值\n@param {Array} extra.leftData 左面板数据\n@param {Array} extra.movedValue 发生移动的值\n@param {Object} extra.movedData 发生移动的数据\n@param {String} extra.direction 移动的方向，值为'left'或'right'",
"params": [
{
"name": "value",
"description": "右面板值",
"type": {
"name": "Array"
}
},
{
"name": "data",
"description": "右面板数据",
"type": {
"name": "Array"
}
},
{
"name": "extra",
"description": "额外参数",
"type": {
"name": "Object"
}
},
{
"name": "extra.leftValue",
"description": "左面板值",
"type": {
"name": "Array"
}
},
{
"name": "extra.leftData",
"description": "左面板数据",
"type": {
"name": "Array"
}
},
{
"name": "extra.movedValue",
"description": "发生移动的值",
"type": {
"name": "Array"
}
},
{
"name": "extra.movedData",
"description": "发生移动的数据",
"type": {
"name": "Object"
}
},
{
"name": "extra.direction",
"description": "移动的方向，值为'left'或'right'",
"type": {
"name": "String"
}
}
],
"returns": null
},
"onSelect": {
"type": {
"name": "func"
},
"required": false,
"description": "Item 被选中的时候触发的回调函数",
"docblock": "Item 被选中的时候触发的回调函数\n@param {Array} sourceSelectedValue 源面板选中的 Item 列表\n@param {Array} targetSelectedValue 目标面板选中的 Item 列表\n@param {String} trigger 触发面板，值为'source'或'target'",
"params": [
{
"name": "sourceSelectedValue",
"description": "源面板选中的 Item 列表",
"type": {
"name": "Array"
}
},
{
"name": "targetSelectedValue",
"description": "目标面板选中的 Item 列表",
"type": {
"name": "Array"
}
},
{
"name": "trigger",
"description": "触发面板，值为'source'或'target'",
"type": {
"name": "String"
}
}
],
"returns": null
},
"disabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否禁用",
"defaultValue": {
"value": "false",
"computed": false
},
"docblock": "是否禁用"
},
"leftDisabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否禁用左侧面板",
"defaultValue": {
"value": "false",
"computed": false
},
"docblock": "是否禁用左侧面板"
},
"rightDisabled": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否禁用右侧面板",
"defaultValue": {
"value": "false",
"computed": false
},
"docblock": "是否禁用右侧面板"
},
"itemRender": {
"type": {
"name": "func"
},
"required": false,
"description": "列表项渲染函数",
"defaultValue": {
"value": "data => data.label",
"computed": false
},
"docblock": "列表项渲染函数\n@param {Object} data 数据\n@return {ReactNode} 列表项内容",
"params": [
{
"name": "data",
"description": "数据",
"type": {
"name": "Object"
}
}
],
"returns": {
"description": "列表项内容",
"type": {
"name": "ReactNode"
}
}
},
"filter": {
"type": {
"name": "func"
},
"required": false,
"description": "自定义搜索函数",
"defaultValue": {
"value": "根据 label 属性匹配",
"computed": false
},
"docblock": "自定义搜索函数\n@param {String} searchedValue 搜索的内容\n@param {Object} data 数据\n@return {Boolean} 是否匹配到\n@default 根据 label 属性匹配",
"params": [
{
"name": "searchedValue",
"description": "搜索的内容",
"type": {
"name": "String"
}
},
{
"name": "data",
"description": "数据",
"type": {
"name": "Object"
}
}
],
"returns": {
"description": "是否匹配到",
"type": {
"name": "Boolean"
}
}
},
"onSearch": {
"type": {
"name": "func"
},
"required": false,
"description": "搜索框输入时触发的回调函数",
"defaultValue": {
"value": "() => {}",
"computed": false
},
"docblock": "搜索框输入时触发的回调函数\n@param {String} searchedValue 搜索的内容\n@param {String} position 搜索面板的位置",
"params": [
{
"name": "searchedValue",
"description": "搜索的内容",
"type": {
"name": "String"
}
},
{
"name": "position",
"description": "搜索面板的位置",
"type": {
"name": "String"
}
}
],
"returns": null
},
"searchPlaceholder": {
"type": {
"name": "string"
},
"required": false,
"description": "搜索框占位符",
"docblock": "搜索框占位符"
},
"showSearch": {
"type": {
"name": "union",
"value": [
{
"name": "bool"
},
{
"name": "arrayOf",
"value": {
"name": "bool"
}
}
]
},
"required": false,
"description": "左右面板是否显示搜索框",
"defaultValue": {
"value": "false",
"computed": false
},
"docblock": "左右面板是否显示搜索框"
},
"searchProps": {
"type": {
"name": "union",
"value": [
{
"name": "object"
},
{
"name": "arrayOf",
"value": {
"name": "object"
}
}
]
},
"required": false,
"description": "左右面板搜索框配置项，同 Search 组件 props",
"docblock": "左右面板搜索框配置项，同 Search 组件 props"
},
"notFoundContent": {
"type": {
"name": "union",
"value": [
{
"name": "node"
},
{
"name": "arrayOf",
"value": {
"name": "node"
}
}
]
},
"required": false,
"description": "列表为空显示内容",
"defaultValue": {
"value": "'Not Found'",
"computed": false
},
"docblock": "列表为空显示内容"
},
"titles": {
"type": {
"name": "arrayOf",
"value": {
"name": "node"
}
},
"required": false,
"description": "左右面板标题",
"defaultValue": {
"value": "[]",
"computed": false
},
"docblock": "左右面板标题"
},
"operations": {
"type": {
"name": "arrayOf",
"value": {
"name": "node"
}
},
"required": false,
"description": "向右向左移动按钮显示内容",
"defaultValue": {
"value": "[, ]",
"computed": false
},
"docblock": "向右向左移动按钮显示内容\n@default [, ]"
},
"defaultLeftChecked": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "左面板默认选中值",
"defaultValue": {
"value": "[]",
"computed": false
},
"docblock": "左面板默认选中值"
},
"defaultRightChecked": {
"type": {
"name": "arrayOf",
"value": {
"name": "string"
}
},
"required": false,
"description": "右面板默认选中值",
"defaultValue": {
"value": "[]",
"computed": false
},
"docblock": "右面板默认选中值"
},
"listClassName": {
"type": {
"name": "string"
},
"required": false,
"description": "左右面板列表自定义样式类名",
"docblock": "左右面板列表自定义样式类名"
},
"listStyle": {
"type": {
"name": "object"
},
"required": false,
"description": "左右面板列表自定义样式对象",
"docblock": "左右面板列表自定义样式对象",
"properties": []
},
"sortable": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否允许拖拽排序",
"defaultValue": {
"value": "false",
"computed": false
},
"docblock": "是否允许拖拽排序"
},
"onSort": {
"type": {
"name": "func"
},
"required": false,
"description": "拖拽排序时触发的回调函数",
"defaultValue": {
"value": "() => {}",
"computed": false
},
"docblock": "拖拽排序时触发的回调函数\n@param {Array} value 排序后的值\n@param {String} position 拖拽的面板位置，值为：left 或 right",
"params": [
{
"name": "value",
"description": "排序后的值",
"type": {
"name": "Array"
}
},
{
"name": "position",
"description": "拖拽的面板位置，值为：left 或 right",
"type": {
"name": "String"
}
}
],
"returns": null
},
"locale": {
"type": {
"name": "object"
},
"required": false,
"description": "自定义国际化文案对象",
"defaultValue": {
"value": "zhCN.Transfer",
"computed": true
},
"docblock": "自定义国际化文案对象",
"properties": []
},
"id": {
"type": {
"name": "string"
},
"required": false,
"description": "请设置 id 以保证transfer的可访问性",
"docblock": "请设置 id 以保证transfer的可访问性"
},
"children": {
"type": {
"name": "func"
},
"required": false,
"description": "接收 children 自定义渲染列表",
"docblock": "接收 children 自定义渲染列表",
"params": [],
"returns": null
},
"useVirtual": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否开启虚拟滚动",
"docblock": "是否开启虚拟滚动"
},
"showCheckAll": {
"type": {
"name": "bool"
},
"required": false,
"description": "是否显示底部全选 checkbox",
"defaultValue": {
"value": "true",
"computed": false
},
"docblock": "是否显示底部全选 checkbox"
}
},
"methods": [],
"subComponents": []
}