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 · basic
• One Way · oneWay
• Search · search
• Advanced · advanced
• Custom datasource · custom-item
• Custom Actions · actions
• Pagination · large-data
• Table Transfer · table-transfer
• Tree Transfer · tree-transfer
• Status · status
• Custom semantic dom styling · style-class

API

Common props ref：Common props

Transfer

Render Props

Transfer accept children to customize render list, using follow props:

example

<Transfer {...props}>{(listProps) => <YourComponent {...listProps} />}</Transfer>

Warning

According to the standard of React, the key should always be supplied directly to the elements in the array. In Transfer, the keys should be set on the elements included in dataSource array. By default, key property is used as a unique identifier.

If there's no key in your data, you should use rowKey to specify the key that will be used to uniquely identify each element.

// eg. your primary key is `uid`
return <Transfer rowKey={(record) => record.uid} />;

Semantic DOM

Semantic description source: vendor/components/transfer/demo/_semantic.tsx

Design Token

Types, inheritance and declarations retain the pinned native source. Defaults are computed by the native theme and may be overridden by ConfigProvider; this table does not invent static defaults.

Declaration source: vendor/components/transfer/style/index.ts

import { unit } from '@ant-design/cssinjs';

import type { CSSObject } from '@ant-design/cssinjs';

import { operationUnit, resetComponent, resetIcon, textEllipsis } from '../../style';

import type { FullToken, GenerateStyle, GetDefaultToken } from '../../theme/internal';

import { genStyleHooks, mergeToken } from '../../theme/internal';

export interface ComponentToken {
  /**
   * @desc 列表宽度
   * @descEN Width of list
   */
  listWidth: number | string;
  /**
   * @desc 大号列表宽度
   * @descEN Width of large list
   */
  listWidthLG: number | string;
  /**
   * @desc 列表高度
   * @descEN Height of list
   */
  listHeight: number | string;
  /**
   * @desc 列表项高度
   * @descEN Height of list item
   */
  itemHeight: number | string;
  /**
   * @desc 列表项纵向内边距
   * @descEN Vertical padding of list item
   */
  itemPaddingBlock: number | string;
  /**
   * @desc 顶部高度
   * @descEN Height of header
   */
  headerHeight: number | string;
}

interface TransferToken extends FullToken<'Transfer'> {
  transferHeaderVerticalPadding: number;
}

FAQ

How to support fetch and present data from a remote server in Transfer column.

In order to keep the page number synchronized, you can disable columns you checked without removing the option: https://codesandbox.io/s/objective-wing-6iqbx

Shared native props

Tips: The following generic properties apply to most antd components; those not supported are described separately.

Install and reproduce an example

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

Use ConfigProvider and native App; configure dayjs locale separately. Each example lists its complete source files and additional pinned dependencies in View code. Example names select demos, not universal component props. See the resource setup guide for theme, locale and SSR.

Native type references

The source viewer includes unchanged native implementations and the following source declarations. Inherited types remain in their native packages. English source comments are preserved as code reference.

• vendor/components/transfer/Actions.tsx
• vendor/components/transfer/ListBody.tsx
• vendor/components/transfer/ListItem.tsx
• vendor/components/transfer/Section.tsx
• vendor/components/transfer/index.tsx
• vendor/components/transfer/interface.ts
• vendor/components/transfer/search.tsx
• vendor/components/transfer/style/index.ts

Source and license

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

Original bilingual prose and executable examples are retained. Website-only embeds and token tables are expanded locally. Ant Design is MIT; separately listed dependency notices also apply. Upload previews block outbound requests and do not provide a backend.