ant-design/components/transfer/index.zh-CN.md

51 lines
2.8 KiB
Markdown
Raw Normal View History

2016-03-31 14:17:09 +08:00
---
category: Components
2016-09-21 11:28:38 +08:00
subtitle: 穿梭框
type: 数据录入
2016-03-31 14:17:09 +08:00
cols: 1
2016-09-21 11:28:38 +08:00
title: Transfer
2016-03-31 14:17:09 +08:00
---
2015-11-25 23:17:06 +08:00
2016-11-09 20:37:10 +08:00
双栏穿梭选择框。
2015-11-25 23:17:06 +08:00
## 何时使用
2015-12-24 20:47:09 +08:00
用直观的方式在两栏中移动元素,完成选择行为。
2015-11-25 23:17:06 +08:00
2016-11-09 20:37:10 +08:00
选择一个或以上的选项后,点击对应的方向键,可以把选中的选项移动到另一栏。
其中,左边一栏为 `source`,右边一栏为 `target`API 的设计也反映了这两个概念。
2016-11-09 20:37:10 +08:00
2015-11-25 23:17:06 +08:00
## API
2017-10-25 10:25:44 +08:00
| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| className | 自定义类 | string | |
2017-10-25 10:25:44 +08:00
| dataSource | 数据源,其中的数据将会被渲染到左边一栏中,`targetKeys` 中指定的除外。 | [TransferItem](https://git.io/vMM64)\[] | \[] |
2018-09-15 15:18:59 +08:00
| disabled | 是否禁用 | boolean | false |
2017-10-25 10:25:44 +08:00
| filterOption | 接收 `inputValue` `option` 两个参数,当 `option` 符合筛选条件时,应返回 `true`,反之则返回 `false`。 | (inputValue, option): boolean | |
| footer | 底部渲染函数 | (props): ReactNode | |
2017-09-09 00:00:24 +08:00
| lazy | Transfer 使用了 [react-lazy-load](https://github.com/loktar00/react-lazy-load) 优化性能,这里可以设置相关参数。设为 `false` 可以关闭懒加载。 | object\|boolean | `{ height: 32, offset: 32 }` |
2017-10-25 10:25:44 +08:00
| listStyle | 两个穿梭框的自定义样式 | object | |
| locale | 各种语言 | object | `{ itemUnit: '项', itemsUnit: '项', notFoundContent: '列表为空', searchPlaceholder: '请输入搜索内容' }` |
2017-10-25 10:25:44 +08:00
| operations | 操作文案集合,顺序从下至上 | string\[] | ['>', '<'] |
| render | 每行数据渲染函数,该函数的入参为 `dataSource` 中的项,返回值为 ReactElement。或者返回一个普通对象其中 `label` 字段为 ReactElement`value` 字段为 title | Function(record) | |
2017-10-25 10:25:44 +08:00
| selectedKeys | 设置哪些项应该被选中 | string\[] | \[] |
| showSearch | 是否显示搜索框 | boolean | false |
| targetKeys | 显示在右侧框数据的key集合 | string\[] | \[] |
| titles | 标题集合,顺序从左至右 | string\[] | ['', ''] |
| onChange | 选项在两栏之间转移时的回调函数 | (targetKeys, direction, moveKeys): void | |
| onScroll | 选项列表滚动时的回调函数 | (direction, event): void | |
2017-03-28 10:41:14 +08:00
| onSearchChange | 搜索框内容时改变时的回调函数 | (direction: 'left'\|'right', event: Event): void | - |
2017-10-25 10:25:44 +08:00
| onSelectChange | 选中项发生改变时的回调函数 | (sourceSelectedKeys, targetSelectedKeys): void | |
## 注意
2017-02-19 17:02:58 +08:00
按照 React 的[规范](http://facebook.github.io/react/docs/lists-and-keys.html#keys),所有的组件数组必须绑定 key。在 Transfer 中,`dataSource`里的数据值需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。
如果你的数据没有这个属性,务必使用 `rowKey` 来指定数据列的主键。
2016-11-04 15:16:16 +08:00
```jsx
// 比如你的数据主键是 uid
return <Transfer rowKey={record => record.uid} />;
2016-08-04 09:45:50 +08:00
```