# bee-transfer

> Transfer ui component for react

Latest version **2.0.20** (published 2020-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install bee-transfer
pnpm add bee-transfer
yarn add bee-transfer
bun add bee-transfer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.20 |
| Published | 2020-09-09 |
| First published | 2017-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 11 |
| Unpacked size | 120.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Yonyou FED |
| Maintainers | gaox2025f, houjitong, tinper-bot, liuyk, banyudu, bjyxszd, huayingjie, npm_yx, yangchch, yonyoufed, jonyw, guoyongfeng, zhaoyuchief, kvkens, liushaozhen, whizbz, ahua52 |
| Keywords | react, react-component, bee-transfer, iuap-design, tinper-bee, Transfer |

## Links

- npm: https://www.npmjs.com/package/bee-transfer
- Repository: https://github.com/tinper-bee/bee-transfer
- Homepage: https://github.com/tinper-bee/bee-transfer.git
- Issues: https://github.com/tinper-bee/bee-transfer.git/issues
- npm.io page: https://npm.io/package/bee-transfer

## Dependencies (11)

- [bee-icon](https://npm.io/package/bee-icon.md) latest
- [bee-button](https://npm.io/package/bee-button.md) latest
- [classnames](https://npm.io/package/classnames.md) ^2.2.5
- [bee-animate](https://npm.io/package/bee-animate.md) ^1.0.0
- [bee-checkbox](https://npm.io/package/bee-checkbox.md) latest
- [shallowequal](https://npm.io/package/shallowequal.md) ^1.0.2
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.23.0
- [react-lazy-load](https://npm.io/package/react-lazy-load.md) ^3.0.12
- [tinper-bee-core](https://npm.io/package/tinper-bee-core.md) latest
- [bee-form-control](https://npm.io/package/bee-form-control.md) latest
- [react-beautiful-dnd](https://npm.io/package/react-beautiful-dnd.md) ^9.0.2

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.20 (latest) — 2020-09-09
- 2.0.21-beta.2 (ncc-transfer) — 2021-06-01
- 1.0.8-ncc.2 (ncc) — 2020-04-15
- 2.0.11-alpha.1 (alpha) — 2019-05-07
- 2.0.21-beta.1 — 2021-05-28
- 2.0.17 — 2020-09-09
- 2.0.14 — 2020-09-09
- 1.0.8-ncc.1 — 2020-04-14
- 2.0.13 — 2020-04-14
- 2.0.12 — 2019-05-08
- 2.0.11 — 2019-05-08
- 2.0.11-alpha.0 — 2019-05-07
- 2.0.10 — 2019-04-28
- 2.0.10-alpha.0 — 2019-04-28
- 2.0.9 — 2019-04-24
- … 23 more at https://npm.io/package/bee-transfer/versions

## README

# bee-transfer

[![npm version](https://img.shields.io/npm/v/bee-transfer.svg)](https://www.npmjs.com/package/bee-transfer)
[![Build Status](https://img.shields.io/travis/tinper-bee/bee-transfer/master.svg)](https://travis-ci.org/tinper-bee/bee-transfer)
[![Coverage Status](https://coveralls.io/repos/github/tinper-bee/bee-transfer/badge.svg?branch=master)](https://coveralls.io/github/tinper-bee/bee-transfer?branch=master)
[![devDependency Status](https://img.shields.io/david/dev/tinper-bee/bee-transfer.svg)](https://david-dm.org/tinper-bee/bee-transfer#info=devDependencies)
[![NPM downloads](http://img.shields.io/npm/dm/bee-transfer.svg?style=flat)](https://npmjs.org/package/bee-transfer)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/tinper-bee/bee-transfer.svg)](http://isitmaintained.com/project/tinper-bee/bee-transfer "Average time to resolve an issue")
[![Percentage of issues still open](http://isitmaintained.com/badge/open/tinper-bee/bee-transfer.svg)](http://isitmaintained.com/project/tinper-bee/bee-transfer "Percentage of issues still open")


两框之间的元素迁移，非常直观且有效。一个或多个元素选择后点击方向按钮转到另一列框中。左栏是“源”，右边是“目标”

## 使用

### 使用单独的transfer包
#### 组件引入
先进行下载bee-transfer包
```
npm install --save bee-transfer
```
组件调用
```js
import Transfer from 'bee-transfer';

const mockData = [];
for (let i = 0; i < 20; i++) {
  mockData.push({
    key: i.toString(),
    title: `content${i + 1}`,
    description: `description of content${i + 1}`,
    disabled: i % 3 < 1,
  });
}


ReactDOM.render(
        <Transfer
		    dataSource={mockData}
		    titles={['Source', 'Target']}
		    render={item => item.title}
		  />
        , document.getElementById('target'));
```
#### 样式引入
- 可以使用link引入build目录下Transfer.css
```
<link rel="stylesheet" href="./node_modules/bee-transfer/build/Transfer.css">
```
- 可以在js中import样式
```js
import "./node_modules/bee-transfer/src/Transfer.scss"
//或是
import "./node_modules/bee-transfer/build/Transfer.css"
```






## API

|参数|说明|类型|默认值|
|:--|:---:|:--:|---:|
|dataSource|设置数据源。当有targetKey props存在时，dataSource的数据刨去targetKey数据,剩下的都放在左边列表|[]|[]|
|render|每行数据渲染函数，该函数的入参为 dataSource 中的项，返回值为 ReactElement。或者返回一个普通对象，其中 label 字段为 ReactElement，value 字段为 title|Function(record)|-|
|targetKeys|展示在右边列表的数据集|[]|[]|
|selectedKeys|所有选中的item的keys|[]|[]|
|onChange|当item在穿梭成功后的回调 参数(targetKeys, direction, moveKeys)|func|-|
|onSelectChange| 当选中的item发生改变时的回调 参数(sourceSelectedKeys, targetSelectedKeys)|fun|-|
|onScroll| 当滑动可选的item列表的回调	参数(direction, event)|func|-|
|listStyle|自定义的columns的样式表|object	|-|
|className|class|string|''|''|
|titles|两columns的title|[]|-|
|operations|自定义按钮操作|[]|'>', '<'|
|showSearch|是否显示搜索框|boolean	|false|
|filterOption|搜索过滤方法	参数(inputValue, option)|func或者boolean	|-|
|searchPlaceholder|搜索框的默认显示文字|string|'Search'|
|notFoundContent|当没有相关内容的显示内容|string或ReactNode|	'Not Found'|
|footer|渲染底部的dom|ReactNode|-|
|lazy|懒加载dom|object|当tranfer放在bee-modal里 添加参数 lazy={{container:"modal"}}|
|onSearchChange|当搜索域变化的回调函数 参数(direction: 'left'|'right', event: Event)|func|-|
|showCheckbox|是否显示Checkbox复选框|bool|true|
|draggable|是否可以通过拖拽进行穿梭和排序|bool|false|
|appendToBottom|是否将已选项追加到右侧列表末尾|bool|false|


#### 开发调试

```sh
$ npm install -g bee-tools
$ git clone https://github.com/tinper-bee/bee-transfer
$ cd bee-transfer
$ npm install
$ npm run dev
```

---
_Source: https://npm.io/package/bee-transfer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._