# 穿梭框

- 页面: https://jiguang132.com/zh/resources/ant-design/docs/transfer
- 资源: Ant Design (https://jiguang132.com/zh/resources/ant-design.md)
- 全部指南: https://jiguang132.com/zh/resources/ant-design/docs.md

双栏穿梭选择框。


## 何时使用 {#when-to-use}

- 需要在多个可选项中进行多选时。
- 比起 Select 和 TreeSelect，穿梭框占据更大的空间，可以展示可选项的更多信息。

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

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

> 注意：穿梭框组件只支持受控使用，不支持非受控模式。

## 代码演示 {#examples}


- 基本用法 · `basic`
- 单向样式 · `oneWay`
- 带搜索框 · `search`
- 高级用法 · `advanced`
- 自定义渲染行数据 · `custom-item`
- 自定义操作按钮 · `actions`
- 分页 · `large-data`
- 表格穿梭框 · `table-transfer`
- 树穿梭框 · `tree-transfer`
- 自定义状态 · `status`
- 自定义语义结构的样式和类 · `style-class`



## API

通用属性参考：[通用属性](#jguang-common-props)

### Transfer

| 参数 | 说明 | 类型 | 默认值 | 版本 | [全局配置](/components/config-provider#component-config) |
| --- | --- | --- | --- | --- | --- |
| actions | 操作文案集合，顺序从上至下。当为字符串数组时使用默认的按钮，当为 ReactNode 数组时直接使用自定义元素 | ReactNode\[] | \[`>`, `<`] | 6.0.0 | × |
| classNames | 用于自定义组件内部各语义化结构的 class，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), string> \| (info: { props })=> Record<[SemanticDOM](#semantic-dom), string> | - | 6.0.0 | 6.0.0 |
| dataSource | 数据源，其中的数据将会被渲染到左边一栏中，`targetKeys` 中指定的除外 | [RecordType extends TransferItem = TransferItem](https://github.com/ant-design/ant-design/blob/1bf0bab2a7bc0a774119f501806e3e0e3a6ba283/components/transfer/index.tsx#L12)\[] | \[] |  | × |
| disabled | 是否禁用 | boolean | false |  | × |
| selectionsIcon | 自定义下拉菜单图标 | React.ReactNode |  | 5.8.0 | 5.14.0 |
| filterOption | 根据搜索内容进行筛选，接收 `inputValue` `option` `direction` 三个参数，(`direction` 自5.9.0+支持)，当 `option` 符合筛选条件时，应返回 true，反之则返回 false | (inputValue, option, direction: `left` \| `right`): boolean | - |  | × |
| footer | 底部渲染函数 | (props, { direction }) => ReactNode | - | direction: 4.17.0 | × |
| ~~listStyle~~ | 两个穿梭框的自定义样式，使用 `styles.section` 代替 | object\|({direction: `left` \| `right`}) => object | - |  | × |
| locale | 各种语言 | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode \| ReactNode[]; } | { itemUnit: `项`, itemsUnit: `项`, searchPlaceholder: `请输入搜索内容`, notFoundContent: `暂无数据` } |  | × |
| oneWay | 展示为单向样式 | boolean | false | 4.3.0 | × |
| ~~operations~~ | 操作文案集合，顺序从上至下。使用 `actions` 代替 | string\[] | \[`>`, `<`] |  | × |
| ~~operationStyle~~ | 操作栏的自定义样式，使用 `styles.actions` 代替 | CSSProperties | - |  | × |
| pagination | 使用分页样式，自定义渲染列表下无效 | boolean \| { pageSize: number, simple: boolean, showSizeChanger?: boolean, showLessItems?: boolean } | false | 4.3.0 | × |
| render | 每行数据渲染函数，该函数的入参为 `dataSource` 中的项，返回值为 ReactElement。或者返回一个普通对象，其中 `label` 字段为 ReactElement，`value` 字段为 title | (record) => ReactNode | - |  | × |
| selectAllLabels | 自定义顶部多选框标题的集合 | (ReactNode \| (info: { selectedCount: number, totalCount: number }) => ReactNode)\[] | - |  | × |
| selectedKeys | 设置哪些项应该被选中 | string\[] \| number\[] | \[] |  | × |
| showSearch | 是否显示搜索框，或可对两侧搜索框进行配置 | boolean \| { placeholder:string,defaultValue:string } | false |  | × |
| showSelectAll | 是否展示全选勾选框 | boolean | true |  | × |
| status | 设置校验状态 | 'error' \| 'warning' | - | 4.19.0 | × |
| styles | 用于自定义组件内部各语义化结构的行内 style，支持对象或函数 | Record<[SemanticDOM](#semantic-dom), CSSProperties> \| (info: { props })=> Record<[SemanticDOM](#semantic-dom), CSSProperties> | - | 6.0.0 | 6.0.0 |
| targetKeys | 显示在右侧框数据的 key 集合 | string\[] \| number\[] | \[] |  | × |
| titles | 标题集合，顺序从左至右 | ReactNode\[] | - |  | × |
| onChange | 选项在两栏之间转移时的回调函数 | (targetKeys, direction, moveKeys): void | - |  | × |
| onScroll | 选项列表滚动时的回调函数 | (direction, event): void | - |  | × |
| onSearch | 搜索框内容时改变时的回调函数 | (direction: `left` \| `right`, value: string): void | - |  | × |
| onSelectChange | 选中项发生改变时的回调函数 | (sourceSelectedKeys, targetSelectedKeys): void | - |  | × |

### Render Props

Transfer 支持接收 `children` 自定义渲染列表，并返回以下参数：

| 参数            | 说明           | 类型                                              | 版本 |
| --------------- | -------------- | ------------------------------------------------- | ---- |
| direction       | 渲染列表的方向 | `left` \| `right`                                 |      |
| disabled        | 是否禁用列表   | boolean                                           |      |
| filteredItems   | 过滤后的数据   | RecordType\[]                                     |      |
| selectedKeys    | 选中的条目     | string\[] \| number\[]                            |      |
| onItemSelect    | 勾选条目       | (key: string \| number, selected: boolean)        |      |
| onItemSelectAll | 勾选一组条目   | (keys: string\[] \| number\[], selected: boolean) |      |

#### 参考示例 {#example}

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

## 注意 {#warning}

按照 React 的[规范](https://zh-hans.react.dev/learn/rendering-lists#why-does-react-need-keys)，所有的组件数组必须绑定 key。在 Transfer 中，`dataSource` 里的数据值需要指定 `key` 值。对于 `dataSource` 默认将每列数据的 `key` 属性作为唯一的标识。

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

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

## Semantic DOM

| 语义节点 | 原生说明 | 版本 |
| --- | --- | --- |
| `root` | 根元素，设置flex布局、穿梭框容器的基础样式和布局控制 | — |
| `section` | 区域元素，设置flex布局、宽度、高度、最小高度、边框、圆角等单侧穿梭框的容器样式 | — |
| `source.section` | 源区域元素，仅作用于左侧穿梭框容器样式 | 6.4.0 |
| `target.section` | 目标区域元素，仅作用于右侧穿梭框容器样式 | 6.4.0 |
| `source.header` | 源头部元素，仅作用于左侧头部区域样式 | 6.4.0 |
| `target.header` | 目标头部元素，仅作用于右侧头部区域样式 | 6.4.0 |
| `source.title` | 源标题元素，仅作用于左侧标题文本样式 | 6.4.0 |
| `target.title` | 目标标题元素，仅作用于右侧标题文本样式 | 6.4.0 |
| `source.body` | 源内容元素，仅作用于左侧列表主体区域样式 | 6.4.0 |
| `target.body` | 目标内容元素，仅作用于右侧列表主体区域样式 | 6.4.0 |
| `source.list` | 源列表元素，仅作用于左侧列表内容区域样式 | 6.4.0 |
| `target.list` | 目标列表元素，仅作用于右侧列表内容区域样式 | 6.4.0 |
| `source.item` | 源列表项元素，仅作用于左侧列表项样式 | 6.4.0 |
| `target.item` | 目标列表项元素，仅作用于右侧列表项样式 | 6.4.0 |
| `source.itemIcon` | 源列表项图标元素，仅作用于左侧图标样式 | 6.4.0 |
| `target.itemIcon` | 目标列表项图标元素，仅作用于右侧图标样式 | 6.4.0 |
| `source.itemContent` | 源列表项内容元素，仅作用于左侧文本内容样式 | 6.4.0 |
| `target.itemContent` | 目标列表项内容元素，仅作用于右侧文本内容样式 | 6.4.0 |
| `source.footer` | 源页脚元素，仅作用于左侧页脚区域样式 | 6.4.0 |
| `target.footer` | 目标页脚元素，仅作用于右侧页脚区域样式 | 6.4.0 |
| `header` | 头部元素，设置flex布局、对齐方式、高度、内边距、颜色、背景色、下边框、圆角等头部区域的样式 | — |
| `title` | 标题元素，设置文本省略、flex占比、文本对齐、自动左边距等标题文字的布局和样式 | — |
| `body` | 内容元素，设置列表主体区域的容器样式和布局控制 | — |
| `list` | 列表元素，设置列表内容的样式、布局和滚动控制 | — |
| `item` | 列表项元素，设置相对定位、内边距、边框、悬停态、选中态、禁用态等列表项的交互样式 | — |
| `itemIcon` | 列表项图标元素，设置复选框等图标的样式和交互状态 | — |
| `itemContent` | 列表项内容元素，设置文本省略、内边距等列表项文本内容的展示样式 | — |
| `footer` | 页脚元素，设置底部操作区域的样式和布局 | — |
| `actions` | 操作元素，设置穿梭按钮组的样式、布局和交互状态 | — |

语义说明来源: `vendor/components/transfer/demo/_semantic.tsx`

## 主题变量（Design Token）{#design-token}

类型、继承关系和原生令牌声明保持固定源码原文；默认值由原生主题计算，并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。

| 令牌 | 类型 | 原生说明 |
| --- | --- | --- |
| `listWidth` | `number \| string` | 列表宽度 |
| `listWidthLG` | `number \| string` | 大号列表宽度 |
| `listHeight` | `number \| string` | 列表高度 |
| `itemHeight` | `number \| string` | 列表项高度 |
| `itemPaddingBlock` | `number \| string` | 列表项纵向内边距 |
| `headerHeight` | `number \| string` | 顶部高度 |

声明来源: `vendor/components/transfer/style/index.ts`

```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

### 怎样让 Transfer 穿梭框列表支持异步数据加载 {#faq-async-data-loading}

为了保持页码同步，在勾选时可以不移除选项而以禁用代替：<https://codesandbox.io/s/objective-wing-6iqbx>


## 原生通用属性 {#jguang-common-props}


> Tips: 以下通用属性适用于 antd 大部分组件，不支持的组件会单独说明。

| 参数 | 说明 | 类型 | 默认值 |
| --- | --- | --- | --- |
| style | 自定义样式 | CSSProperties | - |
| className | 自定义类名 | string | - |
| rootClassName | 添加在组件最外层的 className | string | - |
| autoFocus | 自动获取焦点，仅对表单类、链接、交互容器等可聚焦元素生效 | boolean | false |


## 安装并复现示例

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

使用 ConfigProvider 和原生 App，并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示，不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

## 原生类型参考

源码查看器包含未修改的原生实现和以下声明文件，继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

- `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`

## 来源与许可

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

保留原生中英文正文与可执行示例；官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可，另列依赖的许可证也需保留。上传预览禁止向外发起请求，不提供后端服务。

---

JGuang 全部资源索引: https://jiguang132.com/llms.txt