ant-design/components/card/index.tsx

285 lines
8.3 KiB
TypeScript
Raw Normal View History

import * as React from 'react';
2016-02-19 19:35:49 +08:00
import classNames from 'classnames';
2017-08-02 15:08:55 +08:00
import addEventListener from 'rc-util/lib/Dom/addEventListener';
import omit from 'omit.js';
import Grid from './Grid';
import Meta from './Meta';
import Tabs from '../tabs';
2018-04-20 11:19:30 +08:00
import Row from '../row';
import Col from '../col';
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
import { throttleByAnimationFrameDecorator } from '../_util/throttleByAnimationFrame';
2017-09-27 21:57:18 +08:00
import warning from '../_util/warning';
import { Omit } from '../_util/type';
2016-07-14 13:29:50 +08:00
export { CardGridProps } from './Grid';
export { CardMetaProps } from './Meta';
export type CardType = 'inner';
export interface CardTabListType {
key: string;
tab: React.ReactNode;
disabled?: boolean;
}
export interface CardProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
2016-12-19 15:19:15 +08:00
prefixCls?: string;
2016-07-14 13:29:50 +08:00
title?: React.ReactNode;
extra?: React.ReactNode;
bordered?: boolean;
2018-07-23 01:31:25 +08:00
headStyle?: React.CSSProperties;
2016-07-14 13:29:50 +08:00
bodyStyle?: React.CSSProperties;
style?: React.CSSProperties;
loading?: boolean;
noHovering?: boolean;
2017-09-27 21:57:18 +08:00
hoverable?: boolean;
2017-07-31 20:29:56 +08:00
children?: React.ReactNode;
id?: string;
2016-10-21 16:27:26 +08:00
className?: string;
type?: CardType;
cover?: React.ReactNode;
2018-11-01 14:49:51 +08:00
actions?: React.ReactNode[];
tabList?: CardTabListType[];
onTabChange?: (key: string) => void;
Add the defaultActiveTabKey property for the Card component (#9526) * Add the defaultActiveTabKey property for the Card component (close #8789, #8942) * `activeTabKey` should be added * Improve * Fix large tabs font size, close #9509 * docs: Add TreeSelect[dropdownClassName] * Fix passing dropdownClassName to tree-select * build: update remark-parse requirement to ^5.0.0 (#9545) Updates the requirements on [remark-parse](https://github.com/remarkjs/remark) to permit the latest version. - [Release notes](https://github.com/remarkjs/remark/releases) - [Commits](https://github.com/remarkjs/remark/commits/remark@5.0.0) Signed-off-by: dependabot[bot] <support@dependabot.com> * add Tooltip contextMenu doc * Improve Grid and Layout type definition * fix: focus editor (#9548) * Fix test case for new jsdom (#9527) * Fix test case for new jsdom * use setTimeout as raf in jest jsdom * Fix cancelAnimationFrame * Add comment for facebook/jest#5147 * longer timeout * fix snap * upgrade antd-tools * Update typescript requirement to ~2.7.2 (#9522) Updates the requirements on [typescript](https://github.com/Microsoft/TypeScript) to permit the latest version. - [Release notes](https://github.com/Microsoft/TypeScript/releases) - [Commits](https://github.com/Microsoft/TypeScript/commits/v2.7.2) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix a ts error * build: update react-slick requirement to ~0.20.0 (#9543) Updates the requirements on [react-slick](https://github.com/akiran/react-slick) to permit the latest version. - [Changelog](https://github.com/akiran/react-slick/blob/master/CHANGELOG.md) - [Commits](https://github.com/akiran/react-slick/commits) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix test cases * site: fix intersection-observer polyfill * docs: update recommendation * Fix typo WeexPickerProps -> WeekPickerProps (#9564) * use lodash * Fixed typo on Visualization rules (#9575) Style of a navigation should conform to the its level. should be Style of a navigation should conform to its level. * Improve Radio/Checkbox type definition Close #9574 * Remove AbstractCheckboxChangeEvent, fix TS4029 error See https://github.com/Microsoft/TypeScript/issues/9944 * Update index.en-US.md (#9579) * add transitionName from message.config (#9580) * add transitionName from message.config * Update index.en-US.md (#9579) * modify doc * build: update react-virtualized requirement to ~9.18.5 (#9544) Updates the requirements on [react-virtualized](https://github.com/bvaughn/react-virtualized) to permit the latest version. - [Changelog](https://github.com/bvaughn/react-virtualized/blob/master/CHANGELOG.md) - [Commits](https://github.com/bvaughn/react-virtualized/commits/9.18.5) Signed-off-by: dependabot[bot] <support@dependabot.com> * When treeNode is disabled, its switcher is highlight and clickabled (#9539) * When treeNode is disabled, its switcher is highlight and clickabled * rc-tree@1.7.11 * Fix moment require (#9528) Fix #9502 * Update snapshot
2018-03-10 14:44:12 +08:00
activeTabKey?: string;
defaultActiveTabKey?: string;
2016-07-14 13:29:50 +08:00
}
export interface CardState {
widerPadding: boolean;
}
export default class Card extends React.Component<CardProps, CardState> {
2017-07-14 11:55:00 +08:00
static Grid: typeof Grid = Grid;
static Meta: typeof Meta = Meta;
state = {
widerPadding: false,
};
private resizeEvent: any;
private updateWiderPaddingCalled: boolean = false;
2017-09-17 15:48:44 +08:00
private container: HTMLDivElement;
2018-11-22 23:35:40 +08:00
componentDidMount() {
this.updateWiderPadding();
this.resizeEvent = addEventListener(window, 'resize', this.updateWiderPadding);
2017-09-27 21:57:18 +08:00
if ('noHovering' in this.props) {
warning(
!this.props.noHovering,
2018-04-15 16:52:04 +08:00
'`noHovering` of Card is deprecated, you can remove it safely or use `hoverable` instead.',
2017-09-27 21:57:18 +08:00
);
2018-04-15 16:52:04 +08:00
warning(!!this.props.noHovering, '`noHovering={false}` of Card is deprecated, use `hoverable` instead.');
2017-09-27 21:57:18 +08:00
}
2016-02-22 16:25:13 +08:00
}
2018-11-22 23:35:40 +08:00
componentWillUnmount() {
if (this.resizeEvent) {
this.resizeEvent.remove();
}
2017-07-29 14:16:27 +08:00
(this.updateWiderPadding as any).cancel();
2016-10-14 14:41:21 +08:00
}
2018-11-22 23:35:40 +08:00
@throttleByAnimationFrameDecorator()
updateWiderPadding() {
2017-07-29 14:16:27 +08:00
if (!this.container) {
return;
}
2018-04-15 16:52:04 +08:00
// 936 is a magic card width pixel number indicated by designer
const WIDTH_BOUNDARY_PX = 936;
if (this.container.offsetWidth >= WIDTH_BOUNDARY_PX && !this.state.widerPadding) {
2017-07-29 14:16:27 +08:00
this.setState({ widerPadding: true }, () => {
this.updateWiderPaddingCalled = true; // first render without css transition
});
}
2018-04-15 16:52:04 +08:00
if (this.container.offsetWidth < WIDTH_BOUNDARY_PX && this.state.widerPadding) {
2017-07-29 14:16:27 +08:00
this.setState({ widerPadding: false }, () => {
this.updateWiderPaddingCalled = true; // first render without css transition
});
}
}
2018-11-22 23:35:40 +08:00
2017-11-22 11:07:19 +08:00
onTabChange = (key: string) => {
if (this.props.onTabChange) {
this.props.onTabChange(key);
}
}
2018-11-22 23:35:40 +08:00
saveRef = (node: HTMLDivElement) => {
this.container = node;
}
2018-11-22 23:35:40 +08:00
2017-07-14 16:10:04 +08:00
isContainGrid() {
let containGrid;
React.Children.forEach(this.props.children, (element: JSX.Element) => {
2017-07-14 16:10:04 +08:00
if (element && element.type && element.type === Grid) {
containGrid = true;
}
});
return containGrid;
}
2018-11-22 23:35:40 +08:00
2017-11-22 11:07:19 +08:00
getAction(actions: React.ReactNode[]) {
if (!actions || !actions.length) {
return null;
}
const actionList = actions.map((action, index) => (
<li style={{ width: `${100 / actions.length}%` }} key={`action-${index}`}>
<span>{action}</span>
</li>
),
);
return actionList;
}
2018-11-22 23:35:40 +08:00
2017-09-27 21:57:18 +08:00
// For 2.x compatible
getCompatibleHoverable() {
const { noHovering, hoverable } = this.props;
if ('noHovering' in this.props) {
return !noHovering || hoverable;
}
return !!hoverable;
}
2018-11-22 23:35:40 +08:00
renderCard = ({ getPrefixCls }: ConfigConsumerProps) => {
const {
prefixCls: customizePrefixCls,
className, extra, headStyle = {}, bodyStyle = {}, noHovering, hoverable, title, loading,
bordered = true, type, cover, actions, tabList, children, activeTabKey, defaultActiveTabKey, ...others
} = this.props;
2017-07-14 16:10:04 +08:00
const prefixCls = getPrefixCls('card', customizePrefixCls);
const classString = classNames(prefixCls, className, {
[`${prefixCls}-loading`]: loading,
[`${prefixCls}-bordered`]: bordered,
2017-09-27 21:57:18 +08:00
[`${prefixCls}-hoverable`]: this.getCompatibleHoverable(),
[`${prefixCls}-wider-padding`]: this.state.widerPadding,
[`${prefixCls}-padding-transition`]: this.updateWiderPaddingCalled,
2017-07-14 16:10:04 +08:00
[`${prefixCls}-contain-grid`]: this.isContainGrid(),
[`${prefixCls}-contain-tabs`]: tabList && tabList.length,
[`${prefixCls}-type-${type}`]: !!type,
});
2016-02-22 16:25:13 +08:00
const loadingBlockStyle = (bodyStyle.padding === 0 || bodyStyle.padding === '0px')
? { padding: 24 } : undefined;
const loadingBlock = (
<div
className={`${prefixCls}-loading-content`}
style={loadingBlockStyle}
>
2018-04-20 11:19:30 +08:00
<Row gutter={8}>
<Col span={22}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
<Row gutter={8}>
<Col span={8}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={15}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
<Row gutter={8}>
<Col span={6}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={18}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
<Row gutter={8}>
<Col span={13}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={9}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
<Row gutter={8}>
<Col span={4}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={3}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={16}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
<Row gutter={8}>
<Col span={8}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={6}>
<div className={`${prefixCls}-loading-block`} />
</Col>
<Col span={8}>
<div className={`${prefixCls}-loading-block`} />
</Col>
</Row>
</div>
);
Add the defaultActiveTabKey property for the Card component (#9526) * Add the defaultActiveTabKey property for the Card component (close #8789, #8942) * `activeTabKey` should be added * Improve * Fix large tabs font size, close #9509 * docs: Add TreeSelect[dropdownClassName] * Fix passing dropdownClassName to tree-select * build: update remark-parse requirement to ^5.0.0 (#9545) Updates the requirements on [remark-parse](https://github.com/remarkjs/remark) to permit the latest version. - [Release notes](https://github.com/remarkjs/remark/releases) - [Commits](https://github.com/remarkjs/remark/commits/remark@5.0.0) Signed-off-by: dependabot[bot] <support@dependabot.com> * add Tooltip contextMenu doc * Improve Grid and Layout type definition * fix: focus editor (#9548) * Fix test case for new jsdom (#9527) * Fix test case for new jsdom * use setTimeout as raf in jest jsdom * Fix cancelAnimationFrame * Add comment for facebook/jest#5147 * longer timeout * fix snap * upgrade antd-tools * Update typescript requirement to ~2.7.2 (#9522) Updates the requirements on [typescript](https://github.com/Microsoft/TypeScript) to permit the latest version. - [Release notes](https://github.com/Microsoft/TypeScript/releases) - [Commits](https://github.com/Microsoft/TypeScript/commits/v2.7.2) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix a ts error * build: update react-slick requirement to ~0.20.0 (#9543) Updates the requirements on [react-slick](https://github.com/akiran/react-slick) to permit the latest version. - [Changelog](https://github.com/akiran/react-slick/blob/master/CHANGELOG.md) - [Commits](https://github.com/akiran/react-slick/commits) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix test cases * site: fix intersection-observer polyfill * docs: update recommendation * Fix typo WeexPickerProps -> WeekPickerProps (#9564) * use lodash * Fixed typo on Visualization rules (#9575) Style of a navigation should conform to the its level. should be Style of a navigation should conform to its level. * Improve Radio/Checkbox type definition Close #9574 * Remove AbstractCheckboxChangeEvent, fix TS4029 error See https://github.com/Microsoft/TypeScript/issues/9944 * Update index.en-US.md (#9579) * add transitionName from message.config (#9580) * add transitionName from message.config * Update index.en-US.md (#9579) * modify doc * build: update react-virtualized requirement to ~9.18.5 (#9544) Updates the requirements on [react-virtualized](https://github.com/bvaughn/react-virtualized) to permit the latest version. - [Changelog](https://github.com/bvaughn/react-virtualized/blob/master/CHANGELOG.md) - [Commits](https://github.com/bvaughn/react-virtualized/commits/9.18.5) Signed-off-by: dependabot[bot] <support@dependabot.com> * When treeNode is disabled, its switcher is highlight and clickabled (#9539) * When treeNode is disabled, its switcher is highlight and clickabled * rc-tree@1.7.11 * Fix moment require (#9528) Fix #9502 * Update snapshot
2018-03-10 14:44:12 +08:00
const hasActiveTabKey = activeTabKey !== undefined;
const extraProps = {
[hasActiveTabKey ? 'activeKey' : 'defaultActiveKey']: hasActiveTabKey
? activeTabKey
: defaultActiveTabKey,
};
let head;
const tabs = tabList && tabList.length ? (
Add the defaultActiveTabKey property for the Card component (#9526) * Add the defaultActiveTabKey property for the Card component (close #8789, #8942) * `activeTabKey` should be added * Improve * Fix large tabs font size, close #9509 * docs: Add TreeSelect[dropdownClassName] * Fix passing dropdownClassName to tree-select * build: update remark-parse requirement to ^5.0.0 (#9545) Updates the requirements on [remark-parse](https://github.com/remarkjs/remark) to permit the latest version. - [Release notes](https://github.com/remarkjs/remark/releases) - [Commits](https://github.com/remarkjs/remark/commits/remark@5.0.0) Signed-off-by: dependabot[bot] <support@dependabot.com> * add Tooltip contextMenu doc * Improve Grid and Layout type definition * fix: focus editor (#9548) * Fix test case for new jsdom (#9527) * Fix test case for new jsdom * use setTimeout as raf in jest jsdom * Fix cancelAnimationFrame * Add comment for facebook/jest#5147 * longer timeout * fix snap * upgrade antd-tools * Update typescript requirement to ~2.7.2 (#9522) Updates the requirements on [typescript](https://github.com/Microsoft/TypeScript) to permit the latest version. - [Release notes](https://github.com/Microsoft/TypeScript/releases) - [Commits](https://github.com/Microsoft/TypeScript/commits/v2.7.2) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix a ts error * build: update react-slick requirement to ~0.20.0 (#9543) Updates the requirements on [react-slick](https://github.com/akiran/react-slick) to permit the latest version. - [Changelog](https://github.com/akiran/react-slick/blob/master/CHANGELOG.md) - [Commits](https://github.com/akiran/react-slick/commits) Signed-off-by: dependabot[bot] <support@dependabot.com> * Fix test cases * site: fix intersection-observer polyfill * docs: update recommendation * Fix typo WeexPickerProps -> WeekPickerProps (#9564) * use lodash * Fixed typo on Visualization rules (#9575) Style of a navigation should conform to the its level. should be Style of a navigation should conform to its level. * Improve Radio/Checkbox type definition Close #9574 * Remove AbstractCheckboxChangeEvent, fix TS4029 error See https://github.com/Microsoft/TypeScript/issues/9944 * Update index.en-US.md (#9579) * add transitionName from message.config (#9580) * add transitionName from message.config * Update index.en-US.md (#9579) * modify doc * build: update react-virtualized requirement to ~9.18.5 (#9544) Updates the requirements on [react-virtualized](https://github.com/bvaughn/react-virtualized) to permit the latest version. - [Changelog](https://github.com/bvaughn/react-virtualized/blob/master/CHANGELOG.md) - [Commits](https://github.com/bvaughn/react-virtualized/commits/9.18.5) Signed-off-by: dependabot[bot] <support@dependabot.com> * When treeNode is disabled, its switcher is highlight and clickabled (#9539) * When treeNode is disabled, its switcher is highlight and clickabled * rc-tree@1.7.11 * Fix moment require (#9528) Fix #9502 * Update snapshot
2018-03-10 14:44:12 +08:00
<Tabs
{...extraProps}
className={`${prefixCls}-head-tabs`}
size="large"
onChange={this.onTabChange}
>
{tabList.map(item => <Tabs.TabPane tab={item.tab} disabled={item.disabled} key={item.key} />)}
2017-08-15 22:50:00 +08:00
</Tabs>
) : null;
if (title || extra || tabs) {
2017-08-15 22:34:48 +08:00
head = (
2018-07-23 01:31:25 +08:00
<div className={`${prefixCls}-head`} style={headStyle}>
2017-09-20 21:56:56 +08:00
<div className={`${prefixCls}-head-wrapper`}>
{title && <div className={`${prefixCls}-head-title`}>{title}</div>}
{extra && <div className={`${prefixCls}-extra`}>{extra}</div>}
</div>
{tabs}
</div>
);
}
const coverDom = cover ? <div className={`${prefixCls}-cover`}>{cover}</div> : null;
const body = (
<div className={`${prefixCls}-body`} style={bodyStyle}>
{loading ? loadingBlock : children}
</div>
);
const actionDom = actions && actions.length ?
<ul className={`${prefixCls}-actions`}>{this.getAction(actions)}</ul> : null;
const divProps = omit(others, [
'onTabChange',
]);
return (
<div {...divProps} className={classString} ref={this.saveRef}>
2017-12-05 13:35:32 +08:00
{head}
{coverDom}
{body}
{actionDom}
</div>
);
}
render() {
return (
<ConfigConsumer>
{this.renderCard}
</ConfigConsumer>
);
}
}