ant-design/components/transfer/index.tsx

479 lines
16 KiB
TypeScript
Raw Normal View History

import * as React from 'react';
2018-08-07 21:07:52 +08:00
import * as PropTypes from 'prop-types';
import classNames from 'classnames';
import List, { TransferListProps } from './list';
2015-12-25 17:53:35 +08:00
import Operation from './operation';
import Search from './search';
import warning from '../_util/warning';
import LocaleReceiver from '../locale-provider/LocaleReceiver';
import defaultLocale from '../locale/default';
2018-12-26 16:01:00 +08:00
import { ConfigConsumer, ConfigConsumerProps, RenderEmptyHandler } from '../config-provider';
2019-03-07 15:39:34 +08:00
import { polyfill } from 'react-lifecycles-compat';
import { TransferListBodyProps } from './renderListBody';
export { TransferListProps } from './list';
export { TransferOperationProps } from './operation';
2017-12-14 10:49:44 +08:00
export { TransferSearchProps } from './search';
2017-11-20 17:41:32 +08:00
export type TransferDirection = 'left' | 'right';
export interface RenderResultObject {
label: React.ReactElement;
value: string;
}
export type RenderResult = React.ReactElement | RenderResultObject | string | null;
type TransferRender = (item: TransferItem) => RenderResult;
2017-11-20 17:41:32 +08:00
export interface TransferItem {
2016-10-24 16:30:38 +08:00
key: string;
2016-07-13 11:14:24 +08:00
title: string;
description?: string;
disabled?: boolean;
[name: string]: any;
}
2016-07-07 20:25:03 +08:00
export interface TransferProps {
2016-12-07 18:08:52 +08:00
prefixCls?: string;
className?: string;
2018-09-15 15:18:59 +08:00
disabled?: boolean;
dataSource: TransferItem[];
targetKeys?: string[];
selectedKeys?: string[];
render?: TransferRender;
onChange?: (targetKeys: string[], direction: string, moveKeys: string[]) => void;
onSelectChange?: (sourceSelectedKeys: string[], targetSelectedKeys: string[]) => void;
2016-12-07 18:08:52 +08:00
style?: React.CSSProperties;
2016-07-13 11:14:24 +08:00
listStyle?: React.CSSProperties;
operationStyle?: React.CSSProperties;
titles?: string[];
operations?: string[];
2016-07-13 11:14:24 +08:00
showSearch?: boolean;
filterOption?: (inputValue: string, item: TransferItem) => boolean;
2016-07-13 11:14:24 +08:00
searchPlaceholder?: string;
notFoundContent?: React.ReactNode;
locale?: {};
2016-12-07 18:08:52 +08:00
footer?: (props: TransferListProps) => React.ReactNode;
body?: (props: TransferListProps) => React.ReactNode;
rowKey?: (record: TransferItem) => string;
2017-11-20 17:41:32 +08:00
onSearchChange?: (direction: TransferDirection, e: React.ChangeEvent<HTMLInputElement>) => void;
onSearch?: (direction: TransferDirection, value: string) => void;
2017-09-09 00:00:24 +08:00
lazy?: {} | boolean;
2017-11-20 17:41:32 +08:00
onScroll?: (direction: TransferDirection, e: React.SyntheticEvent<HTMLDivElement>) => void;
children?: (props: TransferListBodyProps) => React.ReactNode;
showSelectAll?: boolean;
2017-11-20 17:41:32 +08:00
}
export interface TransferLocale {
titles: string[];
notFoundContent: string;
searchPlaceholder: string;
itemUnit: string;
itemsUnit: string;
}
2019-03-07 15:39:34 +08:00
class Transfer extends React.Component<TransferProps, any> {
// For high-level customized Transfer @dqaria
static List = List;
static Operation = Operation;
static Search = Search;
static defaultProps = {
dataSource: [],
locale: {},
showSearch: false,
};
static propTypes = {
prefixCls: PropTypes.string,
2018-09-15 15:18:59 +08:00
disabled: PropTypes.bool,
dataSource: PropTypes.array as PropTypes.Validator<TransferItem[]>,
render: PropTypes.func,
targetKeys: PropTypes.array,
onChange: PropTypes.func,
height: PropTypes.number,
style: PropTypes.object,
listStyle: PropTypes.object,
operationStyle: PropTypes.object,
className: PropTypes.string,
titles: PropTypes.array,
operations: PropTypes.array,
showSearch: PropTypes.bool,
filterOption: PropTypes.func,
searchPlaceholder: PropTypes.string,
notFoundContent: PropTypes.node,
locale: PropTypes.object,
body: PropTypes.func,
footer: PropTypes.func,
rowKey: PropTypes.func,
lazy: PropTypes.oneOfType([PropTypes.object, PropTypes.bool]),
};
2015-11-25 23:17:06 +08:00
static getDerivedStateFromProps(nextProps: TransferProps) {
if (nextProps.selectedKeys) {
const targetKeys = nextProps.targetKeys || [];
return {
sourceSelectedKeys: nextProps.selectedKeys.filter(key => !targetKeys.includes(key)),
targetSelectedKeys: nextProps.selectedKeys.filter(key => targetKeys.includes(key)),
};
}
return null;
}
separatedDataSource: {
2018-12-07 20:02:01 +08:00
leftDataSource: TransferItem[];
rightDataSource: TransferItem[];
} | null = null;
2016-08-08 14:42:29 +08:00
constructor(props: TransferProps) {
2015-11-25 23:17:06 +08:00
super(props);
warning(
!('notFoundContent' in props || 'searchPlaceholder' in props),
'Transfer',
'`notFoundContent` and `searchPlaceholder` will be removed, ' +
'please use `locale` instead.',
);
warning(
!('body' in props),
'Transfer',
'`body` is internal usage and will bre removed, please use `children` instead.',
);
const { selectedKeys = [], targetKeys = [] } = props;
2015-11-25 23:17:06 +08:00
this.state = {
sourceSelectedKeys: selectedKeys.filter(key => targetKeys.indexOf(key) === -1),
targetSelectedKeys: selectedKeys.filter(key => targetKeys.indexOf(key) > -1),
2015-11-25 23:17:06 +08:00
};
}
2016-07-15 14:01:51 +08:00
separateDataSource(props: TransferProps) {
2017-05-11 11:38:32 +08:00
const { dataSource, rowKey, targetKeys = [] } = props;
2015-12-21 15:29:02 +08:00
const leftDataSource: TransferItem[] = [];
2017-05-11 11:38:32 +08:00
const rightDataSource: TransferItem[] = new Array(targetKeys.length);
dataSource.forEach(record => {
if (rowKey) {
record.key = rowKey(record);
}
2017-05-11 11:38:32 +08:00
// rightDataSource should be ordered by targetKeys
// leftDataSource should be ordered by dataSource
const indexOfKey = targetKeys.indexOf(record.key);
if (indexOfKey !== -1) {
rightDataSource[indexOfKey] = record;
} else {
leftDataSource.push(record);
}
});
2019-03-08 15:34:29 +08:00
return {
leftDataSource,
rightDataSource,
2015-12-21 15:29:02 +08:00
};
2015-12-16 23:02:49 +08:00
}
2017-11-20 17:41:32 +08:00
moveTo = (direction: TransferDirection) => {
const { targetKeys = [], dataSource = [], onChange } = this.props;
const { sourceSelectedKeys, targetSelectedKeys } = this.state;
const moveKeys = direction === 'right' ? sourceSelectedKeys : targetSelectedKeys;
// filter the disabled options
2018-12-07 20:02:01 +08:00
const newMoveKeys = moveKeys.filter(
(key: string) => !dataSource.some(data => !!(key === data.key && data.disabled)),
2017-11-20 17:41:32 +08:00
);
2015-12-21 15:29:02 +08:00
// move items to target box
2018-12-07 20:02:01 +08:00
const newTargetKeys =
direction === 'right'
? newMoveKeys.concat(targetKeys)
: targetKeys.filter(targetKey => newMoveKeys.indexOf(targetKey) === -1);
2015-12-21 15:29:02 +08:00
// empty checked keys
const oppositeDirection = direction === 'right' ? 'left' : 'right';
2015-12-21 15:29:02 +08:00
this.setState({
[this.getSelectedKeysName(oppositeDirection)]: [],
2015-12-21 15:29:02 +08:00
});
this.handleSelectChange(oppositeDirection, []);
2015-12-21 15:29:02 +08:00
2016-10-24 16:30:38 +08:00
if (onChange) {
onChange(newTargetKeys, direction, newMoveKeys);
2016-10-24 16:30:38 +08:00
}
2018-12-07 20:02:01 +08:00
};
2015-11-25 23:17:06 +08:00
moveToLeft = () => this.moveTo('left');
moveToRight = () => this.moveTo('right');
2016-03-30 17:06:19 +08:00
2017-11-20 17:41:32 +08:00
handleSelectChange(direction: TransferDirection, holder: string[]) {
const { sourceSelectedKeys, targetSelectedKeys } = this.state;
const onSelectChange = this.props.onSelectChange;
2016-10-24 16:30:38 +08:00
if (!onSelectChange) {
return;
}
if (direction === 'left') {
onSelectChange(holder, targetSelectedKeys);
} else {
onSelectChange(sourceSelectedKeys, holder);
}
}
onItemSelectAll = (direction: TransferDirection, selectedKeys: string[], checkAll: boolean) => {
const originalSelectedKeys = this.state[this.getSelectedKeysName(direction)] || [];
let mergedCheckedKeys = [];
if (checkAll) {
// Merge current keys with origin key
mergedCheckedKeys = Array.from(new Set([...originalSelectedKeys, ...selectedKeys]));
} else {
// Remove current keys from origin keys
mergedCheckedKeys = originalSelectedKeys.filter(
(key: string) => selectedKeys.indexOf(key) === -1,
);
}
this.handleSelectChange(direction, mergedCheckedKeys);
if (!this.props.selectedKeys) {
this.setState({
[this.getSelectedKeysName(direction)]: mergedCheckedKeys,
});
}
2018-12-07 20:02:01 +08:00
};
2015-11-25 23:17:06 +08:00
handleSelectAll = (
direction: TransferDirection,
filteredDataSource: TransferItem[],
checkAll: boolean,
) => {
warning(
false,
'Transfer',
'`handleSelectAll` will be removed, please use `onSelectAll` instead.',
);
this.onItemSelectAll(direction, filteredDataSource.map(({ key }) => key), !checkAll);
};
// [Legacy] Old prop `body` pass origin check as arg. It's confusing.
// TODO: Remove this in next version.
2018-12-07 20:02:01 +08:00
handleLeftSelectAll = (filteredDataSource: TransferItem[], checkAll: boolean) =>
this.handleSelectAll('left', filteredDataSource, !checkAll);
2018-12-07 20:02:01 +08:00
handleRightSelectAll = (filteredDataSource: TransferItem[], checkAll: boolean) =>
this.handleSelectAll('right', filteredDataSource, !checkAll);
onLeftItemSelectAll = (selectedKeys: string[], checkAll: boolean) =>
this.onItemSelectAll('left', selectedKeys, checkAll);
onRightItemSelectAll = (selectedKeys: string[], checkAll: boolean) =>
this.onItemSelectAll('right', selectedKeys, checkAll);
2016-03-30 17:06:19 +08:00
2017-11-20 17:41:32 +08:00
handleFilter = (direction: TransferDirection, e: React.ChangeEvent<HTMLInputElement>) => {
const { onSearchChange, onSearch } = this.props;
const value = e.target.value;
if (onSearchChange) {
warning(false, 'Transfer', '`onSearchChange` is deprecated. Please use `onSearch` instead.');
onSearchChange(direction, e);
}
if (onSearch) {
onSearch(direction, value);
}
2018-12-07 20:02:01 +08:00
};
2015-11-26 16:07:11 +08:00
2017-11-20 17:41:32 +08:00
handleLeftFilter = (e: React.ChangeEvent<HTMLInputElement>) => this.handleFilter('left', e);
handleRightFilter = (e: React.ChangeEvent<HTMLInputElement>) => this.handleFilter('right', e);
2016-03-30 17:06:19 +08:00
handleClear = (direction: TransferDirection) => {
const { onSearch } = this.props;
if (onSearch) {
onSearch(direction, '');
}
2018-12-07 20:02:01 +08:00
};
2015-11-25 23:17:06 +08:00
handleLeftClear = () => this.handleClear('left');
handleRightClear = () => this.handleClear('right');
2016-03-30 17:06:19 +08:00
onItemSelect = (direction: TransferDirection, selectedKey: string, checked: boolean) => {
const { sourceSelectedKeys, targetSelectedKeys } = this.state;
const holder = direction === 'left' ? [...sourceSelectedKeys] : [...targetSelectedKeys];
const index = holder.indexOf(selectedKey);
if (index > -1) {
2015-12-21 15:29:02 +08:00
holder.splice(index, 1);
}
if (checked) {
holder.push(selectedKey);
2015-12-21 15:29:02 +08:00
}
this.handleSelectChange(direction, holder);
if (!this.props.selectedKeys) {
this.setState({
[this.getSelectedKeysName(direction)]: holder,
});
}
2018-12-07 20:02:01 +08:00
};
2015-11-25 23:17:06 +08:00
handleSelect = (direction: TransferDirection, selectedItem: TransferItem, checked: boolean) => {
warning(false, 'Transfer', '`handleSelect` will be removed, please use `onSelect` instead.');
this.onItemSelect(direction, selectedItem.key, checked);
2018-12-07 20:02:01 +08:00
};
handleLeftSelect = (selectedItem: TransferItem, checked: boolean) =>
this.handleSelect('left', selectedItem, checked);
handleRightSelect = (selectedItem: TransferItem, checked: boolean) =>
this.handleSelect('right', selectedItem, checked);
2017-11-20 17:41:32 +08:00
onLeftItemSelect = (selectedKey: string, checked: boolean) =>
this.onItemSelect('left', selectedKey, checked);
onRightItemSelect = (selectedKey: string, checked: boolean) =>
this.onItemSelect('right', selectedKey, checked);
2016-03-30 17:06:19 +08:00
2017-11-20 17:41:32 +08:00
handleScroll = (direction: TransferDirection, e: React.SyntheticEvent<HTMLDivElement>) => {
const { onScroll } = this.props;
if (onScroll) {
onScroll(direction, e);
}
2018-12-07 20:02:01 +08:00
};
2017-11-20 17:41:32 +08:00
handleLeftScroll = (e: React.SyntheticEvent<HTMLDivElement>) => this.handleScroll('left', e);
handleRightScroll = (e: React.SyntheticEvent<HTMLDivElement>) => this.handleScroll('right', e);
2017-11-20 17:41:32 +08:00
getTitles(transferLocale: TransferLocale): string[] {
const { props } = this;
2016-12-07 18:08:52 +08:00
if (props.titles) {
return props.titles;
}
return transferLocale.titles;
}
2017-11-20 17:41:32 +08:00
getSelectedKeysName(direction: TransferDirection) {
return direction === 'left' ? 'sourceSelectedKeys' : 'targetSelectedKeys';
}
2018-12-26 16:01:00 +08:00
getLocale = (transferLocale: TransferLocale, renderEmpty: RenderEmptyHandler) => {
// Keep old locale props still working.
2018-12-26 16:01:00 +08:00
const oldLocale: { notFoundContent?: any; searchPlaceholder?: string } = {
notFoundContent: renderEmpty('Transfer'),
};
if ('notFoundContent' in this.props) {
oldLocale.notFoundContent = this.props.notFoundContent;
}
if ('searchPlaceholder' in this.props) {
oldLocale.searchPlaceholder = this.props.searchPlaceholder;
}
2018-12-07 20:02:01 +08:00
return { ...transferLocale, ...oldLocale, ...this.props.locale };
};
renderTransfer = (transferLocale: TransferLocale) => (
<ConfigConsumer>
2018-12-26 16:01:00 +08:00
{({ getPrefixCls, renderEmpty }: ConfigConsumerProps) => {
const {
prefixCls: customizePrefixCls,
className,
disabled,
operations = [],
showSearch,
body,
footer,
style,
listStyle,
operationStyle,
filterOption,
render,
lazy,
children,
showSelectAll,
} = this.props;
const prefixCls = getPrefixCls('transfer', customizePrefixCls);
2018-12-26 16:01:00 +08:00
const locale = this.getLocale(transferLocale, renderEmpty);
const { sourceSelectedKeys, targetSelectedKeys } = this.state;
const { leftDataSource, rightDataSource } = this.separateDataSource(this.props);
const leftActive = targetSelectedKeys.length > 0;
const rightActive = sourceSelectedKeys.length > 0;
const cls = classNames(className, prefixCls, {
[`${prefixCls}-disabled`]: disabled,
[`${prefixCls}-customize-list`]: !!children,
});
const titles = this.getTitles(locale);
return (
<div className={cls} style={style}>
<List
prefixCls={`${prefixCls}-list`}
titleText={titles[0]}
dataSource={leftDataSource}
filterOption={filterOption}
style={listStyle}
checkedKeys={sourceSelectedKeys}
handleFilter={this.handleLeftFilter}
handleClear={this.handleLeftClear}
handleSelect={this.handleLeftSelect}
handleSelectAll={this.handleLeftSelectAll}
onItemSelect={this.onLeftItemSelect}
onItemSelectAll={this.onLeftItemSelectAll}
render={render}
showSearch={showSearch}
body={body}
renderList={children}
footer={footer}
lazy={lazy}
onScroll={this.handleLeftScroll}
disabled={disabled}
direction="left"
showSelectAll={showSelectAll}
{...locale}
/>
<Operation
className={`${prefixCls}-operation`}
rightActive={rightActive}
rightArrowText={operations[0]}
moveToRight={this.moveToRight}
leftActive={leftActive}
leftArrowText={operations[1]}
moveToLeft={this.moveToLeft}
style={operationStyle}
disabled={disabled}
/>
<List
prefixCls={`${prefixCls}-list`}
titleText={titles[1]}
dataSource={rightDataSource}
filterOption={filterOption}
style={listStyle}
checkedKeys={targetSelectedKeys}
handleFilter={this.handleRightFilter}
handleClear={this.handleRightClear}
handleSelect={this.handleRightSelect}
handleSelectAll={this.handleRightSelectAll}
onItemSelect={this.onRightItemSelect}
onItemSelectAll={this.onRightItemSelectAll}
render={render}
showSearch={showSearch}
body={body}
renderList={children}
footer={footer}
lazy={lazy}
onScroll={this.handleRightScroll}
disabled={disabled}
direction="right"
showSelectAll={showSelectAll}
{...locale}
/>
</div>
);
}}
</ConfigConsumer>
);
render() {
return (
2018-12-07 20:02:01 +08:00
<LocaleReceiver componentName="Transfer" defaultLocale={defaultLocale.Transfer}>
{this.renderTransfer}
</LocaleReceiver>
);
}
}
2019-03-07 15:39:34 +08:00
polyfill(Transfer);
export default Transfer;