ant-design/components/transfer/index.zh-CN.md
Wei Zhu 77b78a9389 docs: Unify type naming (#4636)
* Unify name of ReactNode type in document

* Lowser all string type name

* Lowercase all number type name

* Lowercase all boolean type name

* Unify array type

* Lowercase all object type name

* Unify mutilple types
2017-01-20 20:10:50 +08:00

2.6 KiB
Raw Blame History

category subtitle type cols title
Components 穿梭框 Data Entry 1 Transfer

双栏穿梭选择框。

何时使用

用直观的方式在两栏中移动元素,完成选择行为。

选择一个或以上的选项后,点击对应的方向键,可以把选中的选项移动到另一栏。 其中,左边一栏为 source,右边一栏为 targetAPI 的设计也反应了这两个概念。

API

参数 说明 类型 默认值
dataSource 数据源,其中的数据将会被渲染到左边一栏中,targetKeys 中指定的除外。 TransferItem[] []
render 每行数据渲染函数,该函数的入参为 dataSource 中的项,返回值为 ReactElement Function(record)
targetKeys 显示在右侧框数据的key集合 string[] []
selectedKeys 设置哪些项应该被选中 string[] []
onChange 选项在两栏之间转移时的回调函数 (targetKeys, direction, moveKeys): void
onSelectChange 选中项发生改变时的回调函数 (sourceSelectedKeys, targetSelectedKeys): void
listStyle 两个穿梭框的自定义样式 object
className 自定义类 string
titles 标题集合,顺序从左至右 string[] ['', '']
operations 操作文案集合,顺序从上至下 string[] []
showSearch 是否显示搜索框 boolean false
filterOption 接收 inputValue option 两个参数,当 option 符合筛选条件时,应返回 true,反之则返回 false (inputValue, option): boolean
searchPlaceholder 搜索框的默认值 string '请输入搜索内容'
notFoundContent 当列表为空时显示的内容 string|ReactNode '列表为空'
footer 底部渲染函数 (props): ReactNode
lazy Transfer 使用了 react-lazy-load 优化性能,这里可以设置相关参数 object { height: 32, offset: 32 }

注意

按照 React 的规范,所有的组件数组必须绑定 key。在 Transfer 中,dataSource里的数据值需要指定 key 值。对于 dataSource 默认将每列数据的 key 属性作为唯一的标识。

如果你的数据没有这个属性,务必使用 rowKey 来指定数据列的主键。

// 比如你的数据主键是 uid
return <Transfer rowKey={record => record.uid} />;