Transfer

Double column transfer choice box.

When to use

It is a select control essentially which can be used for selecting multiple items.
Transfer can display more information for items and take up more space.

Transfer the elements between two columns in an intuitive and efficient way.

One or more elements can be selected from either column, one click on the proper direction button, and the transfer is done. The left column is considered the source and the right column is considered the target. As you can see, these names are reflected in the API.

Notice: Transfer is a controlled component, uncontrolled mode is not supported.

Examples

Basic

The most basic usage of Transfer involves providing the source data and target keys arrays, plus the rendering and some callback functions.

One Way

Use oneWay to make Transfer the one way style.

Search

Transfer with a search box.

Advanced

Advanced Usage of Transfer. You can customize the labels of the transfer buttons, the width and height of the columns, and what should be displayed in the footer.

Custom datasource

Customize each Transfer Item, allowing you to render a complex datasource.

Custom Actions

You can customize operations with the actions prop. This example demonstrates how to customize actions, including handling disabled and loading states. When actions is an array of strings, it will use the default Button component and set the strings as button text. When actions is an array of React elements, it will use these elements directly as action buttons, allowing you to use custom button components, such as buttons with loading state in this example. Note: 1. When using custom buttons, the Transfer component will automatically handle the button's disabled state and click events. 2. You can add a disabled property to your custom button to control its disabled state. 3. You can add an onClick event handler to your custom button, which will be merged with the Transfer component's internal handler.

Pagination

Store a large amount of items with pagination.

Table Transfer

Customize the render list with a Table component.

Tree Transfer

Customize the render list with a Tree component.

Status

Add status to Transfer with status, which could be error or warning.

Custom semantic dom styling

You can customize the semantic dom style of Transfers by passing objects/functions through classNames and styles.

API

Transfer are exported from @ceebee/ui/client.

Transfer

Property	Description	Type	Default	Version
`actions`	A set of operations that are sorted from top to bottom. When an array of strings is provided, default buttons will be used; when an array of ReactNode is provided, custom elements will be used	`ReactNode\[]`	`\[>, <]`	6.0.0
`classNames`	Customize class for each semantic structure inside the component. Supports object or function.	`Record<SemanticDOM, string> \| (info: { props })=> Record<SemanticDOM, string>`	`-`	6.0.0
`dataSource`	Used for setting the source data. The elements that are part of this array will be present the left column. Except the elements whose keys are included in targetKeys prop	`RecordType extends TransferItem = TransferItem\[]`	`\[]`	—
`disabled`	Whether disabled transfer	`boolean`	`false`	—
`selectionsIcon`	custom dropdown icon	`React.ReactNode`	`—`	5.8.0
`filterOption`	A function to determine whether an item should show in search result list, only works when searching, (add direction support since 5.9.0+)	`(inputValue, option, direction: left \| right): boolean`	`-`	—
`footer`	A function used for rendering the footer	`(props, { direction }) => ReactNode`	`-`	direction: 4.17.0
`listStyle`	A custom CSS style used for rendering the transfer columns. Use styles.section instead	`object \| ({direction: left \| right}) => object`	`-`	—
`locale`	The i18n text including filter, empty text, item unit, etc	`{ itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode \| ReactNode[]; }`	`{ itemUnit: item, itemsUnit: items, notFoundContent: The list is empty, searchPlaceholder: Search here }`	—
`oneWay`	Display as single direction style	`boolean`	`false`	4.3.0
`operations`	A set of operations that are sorted from top to bottom. Use actions instead.	`string\[]`	`\[>, <]`	—
`operationStyle`	A custom CSS style used for rendering the operations column. Use styles.actions instead.	`object`	`-`	—
`pagination`	Use pagination. Not work in render props	`boolean \| { pageSize: number, simple: boolean, showSizeChanger?: boolean, showLessItems?: boolean }`	`false`	4.3.0
`render`	The function to generate the item shown on a column. Based on an record (element of the dataSource array), this function should return a React element which is generated from that record. Also, it can return a plain object with value and label, label is a React element and value is for title	`(record) => ReactNode`	`-`	—
`selectAllLabels`	A set of customized labels for select all checkboxes on the header	`(ReactNode \| (info: { selectedCount: number, totalCount: number }) => ReactNode)\[]`	`-`	—
`selectedKeys`	A set of keys of selected items	`string\[] \| number\[]`	`\[]`	—
`showSearch`	If included, a search box is shown on each column	`boolean \| { placeholder:string,defaultValue:string }`	`false`	—
`showSelectAll`	Show select all checkbox on the header	`boolean`	`true`	—
`status`	Set validation status	`'error' \| 'warning'`	`-`	4.19.0
`styles`	Customize inline style for each semantic structure inside the component. Supports object or function.	`Record<SemanticDOM, CSSProperties> \| (info: { props })=> Record<SemanticDOM, CSSProperties>`	`-`	6.0.0
`targetKeys`	A set of keys of elements that are listed on the right column	`string\[] \| number\[]`	`\[]`	—
`titles`	A set of titles that are sorted from left to right	`ReactNode\[]`	`-`	—
`onChange`	A callback function that is executed when the transfer between columns is complete	`(targetKeys, direction, moveKeys): void`	`-`	—
`onScroll`	A callback function which is executed when scroll options list	`(direction, event): void`	`-`	—
`onSearch`	A callback function which is executed when search field are changed	`(direction: left \| right, value: string): void`	`-`	—
`onSelectChange`	A callback function which is executed when selected items are changed	`(sourceSelectedKeys, targetSelectedKeys): void`	`-`	—

Render Props

Property	Description	Type	Default	Version
`direction`	List render direction	`left \| right`	`—`	—
`disabled`	Disable list or not	`boolean`	`—`	—
`filteredItems`	Filtered items	`RecordType\[]`	`—`	—
`selectedKeys`	Selected items	`string\[] \| number\[]`	`—`	—
`onItemSelect`	Select item	`(key: string \| number, selected: boolean)`	`—`	—
`onItemSelectAll`	Select a group of items	`(keys: string\[] \| number\[], selected: boolean)`	`—`	—