ant-design/components/tabs/index.tsx

200 lines
6.0 KiB
TypeScript
Raw Normal View History

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import RcTabs, { TabPane } from 'rc-tabs';
import TabContent from 'rc-tabs/lib/TabContent';
2015-12-14 16:30:15 +08:00
import classNames from 'classnames';
2019-08-05 18:38:10 +08:00
import omit from 'omit.js';
import { CloseOutlined, PlusOutlined } from '@ant-design/icons';
2019-08-05 18:38:10 +08:00
import TabBar from './TabBar';
use ant design icons 4.0 (#18217) * feat: use @ant-design/icons@4.0 * feat: use createFromIconfontCN to make site works * feat: update doc for Icon * feat: use icon in component Alert * feat: use icon in component Avatar * feat: use icon in component Breadcrumb * feat: use icon in component Button * feat: use icon in component Cascader * feat: use icon in component Collapse * feat: use icon in component Datepicker * feat: use icon in component Dropdown * feat: use icon in component Form * feat: use icon in component Input * feat: use icon in component InputNumber * feat: use icon in component Layout * feat: use icon in component Mention * feat: use icon in component Message * feat: use icon in component Modal * feat: use icon in component Notification * feat: use icon in component PageHeader * feat: use icon in component Pagination * feat: use icon in component Popconfirm * feat: use icon in component Progress * feat: use icon in component Rate * feat: use icon in component Result * feat: use icon in component Select * feat: use icon in component Step * feat: use icon in component Switch * feat: use icon in component Table * feat: use icon in component Tab * feat: use icon in component Tag * feat: handle rest component which using Icon * fix: remove unused vars * feat: use latest alpha ant design icons * fix: failed test in uploadlist.test.js * test: update snapshot for icons * doc: add Icon for site * doc: use @ant-design/icons in site * chore: use latest icons * fix: tslint issue * fix: test cases * fix: types for react * fix: lint rules for import orders * fix: use @ant-design/icons@4.0.0-alpha.5 to avoid insert css in server render * fix: eslint error in demo/**.md * inject antd icons * update snapshot * fix site * doc: update docs * fix: code snippets icon in site * feat: use latest @ant-design/icons * fix: icon props in message
2019-08-13 14:07:17 +08:00
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
import warning from '../_util/warning';
import { isFlexSupported } from '../_util/styleChecker';
2015-06-12 12:01:02 +08:00
export type TabsType = 'line' | 'card' | 'editable-card';
2016-09-13 15:31:29 +08:00
export type TabsPosition = 'top' | 'right' | 'bottom' | 'left';
2016-07-09 10:50:51 +08:00
export interface TabsProps {
activeKey?: string;
defaultActiveKey?: string;
hideAdd?: boolean;
onChange?: (activeKey: string) => void;
onTabClick?: Function;
onPrevClick?: React.MouseEventHandler<HTMLElement>;
onNextClick?: React.MouseEventHandler<HTMLElement>;
2016-10-24 16:30:38 +08:00
tabBarExtraContent?: React.ReactNode | null;
2017-02-21 14:43:48 +08:00
tabBarStyle?: React.CSSProperties;
2016-07-09 10:50:51 +08:00
type?: TabsType;
tabPosition?: TabsPosition;
onEdit?: (targetKey: string | React.MouseEvent<HTMLElement>, action: 'add' | 'remove') => void;
2017-10-18 21:17:18 +08:00
size?: 'large' | 'default' | 'small';
2016-07-09 10:50:51 +08:00
style?: React.CSSProperties;
2016-08-16 18:07:37 +08:00
prefixCls?: string;
className?: string;
2018-12-07 20:02:01 +08:00
animated?: boolean | { inkBar: boolean; tabPane: boolean };
2017-12-17 23:47:19 +08:00
tabBarGutter?: number;
2019-07-16 17:32:55 +08:00
renderTabBar?: (
props: TabsProps,
DefaultTabBar: React.ComponentClass<any>,
) => React.ReactElement<any>;
destroyInactiveTabPane?: boolean;
2016-07-09 10:50:51 +08:00
}
// Tabs
export interface TabPaneProps {
2016-07-13 17:22:23 +08:00
/** 选项卡头显示文字 */
tab?: React.ReactNode | string;
2016-07-09 10:50:51 +08:00
style?: React.CSSProperties;
closable?: boolean;
className?: string;
disabled?: boolean;
forceRender?: boolean;
2018-10-21 00:24:47 +08:00
key?: string;
2016-07-09 10:50:51 +08:00
}
export default class Tabs extends React.Component<TabsProps, any> {
static TabPane = TabPane as React.ClassicComponentClass<TabPaneProps>;
static defaultProps = {
2016-05-24 14:35:21 +08:00
hideAdd: false,
tabPosition: 'top' as TabsPosition,
2016-07-09 10:50:51 +08:00
};
2019-08-05 18:38:10 +08:00
componentDidMount() {
const NO_FLEX = ' no-flex';
const tabNode = ReactDOM.findDOMNode(this) as Element;
if (tabNode && !isFlexSupported && tabNode.className.indexOf(NO_FLEX) === -1) {
tabNode.className += NO_FLEX;
}
}
2017-11-20 22:06:01 +08:00
removeTab = (targetKey: string, e: React.MouseEvent<HTMLElement>) => {
2015-12-14 22:16:25 +08:00
e.stopPropagation();
2015-12-15 16:34:02 +08:00
if (!targetKey) {
return;
2015-12-14 22:16:25 +08:00
}
2016-10-24 16:30:38 +08:00
2019-08-05 18:38:10 +08:00
const { onEdit } = this.props;
2016-10-24 16:30:38 +08:00
if (onEdit) {
onEdit(targetKey, 'remove');
}
2018-12-07 20:02:01 +08:00
};
2017-11-20 22:06:01 +08:00
handleChange = (activeKey: string) => {
2019-08-05 18:38:10 +08:00
const { onChange } = this.props;
2016-10-24 16:30:38 +08:00
if (onChange) {
onChange(activeKey);
}
2018-12-07 20:02:01 +08:00
};
createNewTab = (targetKey: React.MouseEvent<HTMLElement>) => {
const { onEdit } = this.props;
if (onEdit) {
onEdit(targetKey, 'add');
}
2018-12-07 20:02:01 +08:00
};
renderTabs = ({ getPrefixCls }: ConfigConsumerProps) => {
2018-11-10 21:40:21 +08:00
const {
prefixCls: customizePrefixCls,
2016-10-24 16:30:38 +08:00
className = '',
size,
2016-10-24 16:30:38 +08:00
type = 'line',
tabPosition,
children,
animated = true,
hideAdd,
} = this.props;
2018-11-10 21:40:21 +08:00
let { tabBarExtraContent } = this.props;
let tabPaneAnimated = typeof animated === 'object' ? animated.tabPane : animated;
// card tabs should not have animation
if (type !== 'line') {
tabPaneAnimated = 'animated' in this.props ? tabPaneAnimated : false;
}
warning(
2017-10-18 21:17:18 +08:00
!(type.indexOf('card') >= 0 && (size === 'small' || size === 'large')),
'Tabs',
"`type=card|editable-card` doesn't have small or large size, it's by design.",
);
const prefixCls = getPrefixCls('tabs', customizePrefixCls);
2017-10-18 21:17:18 +08:00
const cls = classNames(className, {
[`${prefixCls}-vertical`]: tabPosition === 'left' || tabPosition === 'right',
2017-10-18 21:17:18 +08:00
[`${prefixCls}-${size}`]: !!size,
[`${prefixCls}-card`]: type.indexOf('card') >= 0,
2016-03-02 20:25:19 +08:00
[`${prefixCls}-${type}`]: true,
[`${prefixCls}-no-animation`]: !tabPaneAnimated,
2015-12-14 16:30:15 +08:00
});
2015-12-14 22:16:25 +08:00
// only card type tabs can be added and closed
2017-11-20 22:06:01 +08:00
let childrenWithClose: React.ReactElement<any>[] = [];
2015-12-15 16:34:02 +08:00
if (type === 'editable-card') {
childrenWithClose = [];
React.Children.forEach(children as React.ReactNode, (child, index) => {
if (!React.isValidElement(child)) return child;
2019-08-05 18:38:10 +08:00
let { closable } = child.props;
closable = typeof closable === 'undefined' ? true : closable;
const closeIcon = closable ? (
<CloseOutlined
className={`${prefixCls}-close-x`}
onClick={e => this.removeTab(child.key as string, e)}
/>
) : null;
childrenWithClose.push(
React.cloneElement(child, {
tab: (
<div className={closable ? undefined : `${prefixCls}-tab-unclosable`}>
{child.props.tab}
{closeIcon}
</div>
),
key: child.key || index,
}),
);
});
2015-12-14 22:16:25 +08:00
// Add new tab handler
2016-05-24 14:35:21 +08:00
if (!hideAdd) {
tabBarExtraContent = (
<span>
<PlusOutlined className={`${prefixCls}-new-tab`} onClick={this.createNewTab} />
2016-05-24 14:35:21 +08:00
{tabBarExtraContent}
</span>
);
}
2015-12-14 22:16:25 +08:00
}
2016-03-02 20:25:19 +08:00
2016-04-17 17:47:08 +08:00
tabBarExtraContent = tabBarExtraContent ? (
2018-12-07 20:02:01 +08:00
<div className={`${prefixCls}-extra-content`}>{tabBarExtraContent}</div>
2016-04-17 17:47:08 +08:00
) : null;
2019-08-05 18:38:10 +08:00
const { ...tabBarProps } = this.props;
const contentCls: string = classNames(
`${prefixCls}-${tabPosition}-content`,
type.indexOf('card') >= 0 && `${prefixCls}-card-content`,
);
return (
<RcTabs
{...this.props}
prefixCls={prefixCls}
2016-10-24 16:30:38 +08:00
className={cls}
tabBarPosition={tabPosition}
2019-08-05 18:38:10 +08:00
renderTabBar={() => (
<TabBar {...omit(tabBarProps, ['className'])} tabBarExtraContent={tabBarExtraContent} />
)}
2018-12-07 20:02:01 +08:00
renderTabContent={() => (
<TabContent className={contentCls} animated={tabPaneAnimated} animatedWithMargin />
)}
onChange={this.handleChange}
>
2017-11-20 22:06:01 +08:00
{childrenWithClose.length > 0 ? childrenWithClose : children}
</RcTabs>
);
2018-12-07 20:02:01 +08:00
};
render() {
2018-12-07 20:02:01 +08:00
return <ConfigConsumer>{this.renderTabs}</ConfigConsumer>;
}
2015-06-12 12:01:02 +08:00
}