使用import { Transfer } from 'antd'; |
文档贡献者
穿梭选择框用直观的方式在两栏中移动元素，完成选择行为。
选择一个或以上的选项后，点击对应的方向键，可以把选中的选项移动到另一栏。其中，左边一栏为 source，右边一栏为 target，API 的设计也反映了这两个概念。
注意：穿梭框组件只支持受控使用，不支持非受控模式。
通用属性参考：通用属性
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| actions | 操作文案集合，顺序从上至下。当为字符串数组时使用默认的按钮，当为 ReactNode 数组时直接使用自定义元素 | ReactNode[] | [>, <] | 6.0.0 |
| classNames | 用于自定义组件内部各语义化结构的 class，支持对象或函数 | Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string> | - | |
| dataSource | 数据源，其中的数据将会被渲染到左边一栏中，targetKeys 中指定的除外 | RecordType extends TransferItem = TransferItem[] | [] | |
| disabled | 是否禁用 | boolean | false | |
| selectionsIcon | 自定义下拉菜单图标 | React.ReactNode | 5.8.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 |
两个穿梭框的自定义样式，使用 styles.section 代替 | object|({direction: left | right}) => object | - | ||
| locale | 各种语言 | { itemUnit: string; itemsUnit: string; searchPlaceholder: string; notFoundContent: ReactNode | ReactNode[]; } | { itemUnit: 项, itemsUnit: 项, searchPlaceholder: 请输入搜索内容 } | |
| oneWay | 展示为单向样式 | boolean | false | 4.3.0 |
操作文案集合，顺序从上至下。使用 actions 代替 | string[] | [>, <] | ||
操作栏的自定义样式，使用 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, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties> | - | |
| 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 | - |
Transfer 支持接收 children 自定义渲染列表，并返回以下参数：
| 参数 | 说明 | 类型 | 版本 |
|---|---|---|---|
| direction | 渲染列表的方向 | left | right | |
| disabled | 是否禁用列表 | boolean | |
| filteredItems | 过滤后的数据 | RecordType[] | |
| selectedKeys | 选中的条目 | string[] | number[] | |
| onItemSelect | 勾选条目 | (key: string | number, selected: boolean) | |
| onItemSelectAll | 勾选一组条目 | (keys: string[] | number[], selected: boolean) |
<Transfer {...props}>{(listProps) => <YourComponent {...listProps} />}</Transfer>
按照 React 的规范，所有的组件数组必须绑定 key。在 Transfer 中，dataSource 里的数据值需要指定 key 值。对于 dataSource 默认将每列数据的 key 属性作为唯一的标识。
如果你的数据没有这个属性，务必使用 rowKey 来指定数据列的主键。
// 比如你的数据主键是 uidreturn <Transfer rowKey={(record) => record.uid} />;
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| headerHeight | 顶部高度 | string | number | 40 |
| itemHeight | 列表项高度 | string | number | 32 |
| itemPaddingBlock | 列表项纵向内边距 | string | number | 5 |
| listHeight | 列表高度 | string | number | 200 |
| listWidth | 列表宽度 | string | number | 180 |
| listWidthLG | 大号列表宽度 | string | number | 250 |
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| colorBgContainer | 组件的容器背景色，例如：默认按钮、输入框等。务必不要将其与 `colorBgElevated` 混淆。 | string | #ffffff |
| colorBgContainerDisabled | 控制容器在禁用状态下的背景色。 | string | rgba(0,0,0,0.04) |
| colorBorder | 默认使用的边框颜色, 用于分割不同的元素，例如：表单的分割线、卡片的分割线等。 | string | #d9d9d9 |
| colorError | 用于表示操作失败的 Token 序列，如失败按钮、错误状态提示（Result）组件等。 | string | #ff4d4f |
| colorLink | 控制超链接的颜色。 | string | #1677ff |
| colorLinkActive | 控制超链接被点击时的颜色。 | string | #0958d9 |
| colorLinkHover | 控制超链接悬浮时的颜色。 | string | #69b1ff |
| colorPrimaryBorder | 主色梯度下的描边用色，用在 Slider 等组件的描边上。 | string | #91caff |
| colorSplit | 用于作为分割线的颜色，此颜色和 colorBorderSecondary 的颜色一致，但是用的是透明色。 | string | rgba(5,5,5,0.06) |
| colorText | 最深的文本色。为了符合W3C标准，默认的文本颜色使用了该色，同时这个颜色也是最深的中性色。 | string | rgba(0,0,0,0.88) |
| colorTextDisabled | 控制禁用状态下的字体颜色。 | string | rgba(0,0,0,0.25) |
| colorTextSecondary | 作为第二梯度的文本色，一般用在不那么需要强化文本颜色的场景，例如 Label 文本、Menu 的文本选中态等场景。 | string | rgba(0,0,0,0.65) |
| colorWarning | 用于表示操作警告的 Token 序列，如 Notification、 Alert等警告类组件或 Input 输入类等组件会使用该组梯度变量。 | string | #faad14 |
| borderRadiusLG | LG号圆角，用于组件中的一些大圆角，如 Card、Modal 等一些组件样式。 | number | 8 |
| controlHeightLG | 较高的组件高度 | number | 40 |
| controlItemBgActive | 控制组件项在激活状态下的背景颜色。 | string | #e6f4ff |
| controlItemBgActiveHover | 控制组件项在鼠标悬浮且激活状态下的背景颜色。 | string | #bae0ff |
| controlItemBgHover | 控制组件项在鼠标悬浮时的背景颜色。 | string | rgba(0,0,0,0.04) |
| fontFamily | Ant Design 的字体家族中优先使用系统默认的界面字体，同时提供了一套利于屏显的备用字体库，来维护在不同平台以及浏览器的显示下，字体始终保持良好的易读性和可读性，体现了友好、稳定和专业的特性。 | string | -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji' |
| fontSize | 设计系统中使用最广泛的字体大小，文本梯度也将基于该字号进行派生。 | number | 14 |
| fontSizeIcon | 控制选择器、级联选择器等中的操作图标字体大小。正常情况下与 fontSizeSM 相同。 | number | 12 |
| lineHeight | 文本行高 | number | 1.5714285714285714 |
| lineType | 用于控制组件边框、分割线等的样式，默认是实线 | string | solid |
| lineWidth | 用于控制组件边框、分割线等的宽度 | number | 1 |
| lineWidthFocus | 控制线条的宽度，当组件处于聚焦态时。 | number | 3 |
| linkDecoration | 控制链接文本的装饰样式。 | TextDecoration<string | number> | undefined | none |
| linkFocusDecoration | 控制链接聚焦时文本的装饰样式。 | TextDecoration<string | number> | undefined | none |
| linkHoverDecoration | 控制链接鼠标悬浮时文本的装饰样式。 | TextDecoration<string | number> | undefined | none |
| marginXS | 控制元素外边距，小尺寸。 | number | 8 |
| marginXXS | 控制元素外边距，最小尺寸。 | number | 4 |
| motionDurationSlow | 动效播放速度，慢速。用于大型元素如面板动画交互 | string | 0.3s |
| paddingSM | 控制元素的小内间距。 | number | 12 |
| paddingXS | 控制元素的特小内间距。 | number | 8 |
为了保持页码同步，在勾选时可以不移除选项而以禁用代替：https://codesandbox.io/s/objective-wing-6iqbx
| Name | Tag | Description | |
|---|---|---|---|
| content1 | CAT | description of content1 | |
| content2 | DOG | description of content2 | |
| content3 | BIRD | description of content3 | |
| content4 | CAT | description of content4 | |
| content5 | DOG | description of content5 | |
| content6 | BIRD | description of content6 | |
| content7 | CAT | description of content7 | |
| content8 | DOG | description of content8 | |
| content9 | BIRD | description of content9 | |
| content10 | CAT | description of content10 |
| Name | Tag | Description | |
|---|---|---|---|
暂无数据 | |||