ant-design/components/tooltip/index.tsx

221 lines
6.5 KiB
TypeScript
Raw Normal View History

2016-09-21 11:54:53 +08:00
import React from 'react';
2016-08-24 16:09:55 +08:00
import { cloneElement } from 'react';
import RcTooltip from 'rc-tooltip';
2016-08-24 16:09:55 +08:00
import classNames from 'classnames';
import getPlacements, { AdjustOverflow } from './placements';
export type TooltipPlacement =
'top' | 'left' | 'right' | 'bottom' |
'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' |
'leftTop' | 'leftBottom' | 'rightTop' | 'rightBottom';
2015-06-03 17:08:43 +08:00
2016-11-30 16:43:35 +08:00
export interface AbstractTooltipProps {
prefixCls?: string;
overlayClassName?: string;
2016-07-13 11:14:24 +08:00
style?: React.CSSProperties;
overlayStyle?: React.CSSProperties;
2016-11-30 16:43:35 +08:00
placement?: TooltipPlacement;
builtinPlacements?: Object;
visible?: boolean;
onVisibleChange?: (visible: boolean) => void;
mouseEnterDelay?: number;
mouseLeaveDelay?: number;
transitionName?: string;
trigger?: 'hover' | 'focus' | 'click';
2016-08-22 17:26:14 +08:00
openClassName?: string;
2016-08-31 15:00:13 +08:00
arrowPointAtCenter?: boolean;
autoAdjustOverflow?: boolean | AdjustOverflow;
2017-03-21 16:35:31 +08:00
// getTooltipContainer had been rename to getPopupContainer
getTooltipContainer?: (triggerNode: Element) => HTMLElement;
getPopupContainer?: (triggerNode: Element) => HTMLElement;
2017-05-30 17:48:07 +08:00
children?: React.ReactNode;
2016-11-30 16:43:35 +08:00
}
export interface TooltipProps extends AbstractTooltipProps {
2016-12-19 15:19:15 +08:00
title?: React.ReactNode;
2016-11-30 16:43:35 +08:00
overlay?: React.ReactNode;
2016-07-09 10:54:21 +08:00
}
2016-07-13 11:14:24 +08:00
const splitObject = (obj, keys) => {
const picked = {};
const omited = { ...obj };
keys.forEach(key => {
if (obj && key in obj) {
picked[key] = obj[key];
delete omited[key];
}
});
return { picked, omited };
};
2016-07-09 10:54:21 +08:00
export default class Tooltip extends React.Component<TooltipProps, any> {
static defaultProps = {
prefixCls: 'ant-tooltip',
placement: 'top',
2016-10-07 18:18:23 +08:00
transitionName: 'zoom-big-fast',
mouseEnterDelay: 0.1,
2016-04-07 16:43:00 +08:00
mouseLeaveDelay: 0.1,
arrowPointAtCenter: false,
autoAdjustOverflow: true,
2016-07-13 11:14:24 +08:00
};
2016-04-07 15:02:22 +08:00
tooltip: any;
2016-08-24 16:09:55 +08:00
2016-11-30 16:43:35 +08:00
constructor(props: TooltipProps) {
super(props);
this.state = {
visible: !!props.visible,
2016-11-30 16:43:35 +08:00
};
}
componentWillReceiveProps(nextProps: TooltipProps) {
if ('visible' in nextProps) {
this.setState({ visible: nextProps.visible });
}
}
2016-04-07 15:02:22 +08:00
onVisibleChange = (visible) => {
const { onVisibleChange } = this.props;
if (!('visible' in this.props)) {
this.setState({ visible: this.isNoTitle() ? false : visible });
}
if (onVisibleChange && !this.isNoTitle()) {
onVisibleChange(visible);
2016-10-24 16:30:38 +08:00
}
}
2016-04-07 16:56:13 +08:00
getPopupDomNode() {
return this.tooltip.getPopupDomNode();
2016-04-07 16:56:13 +08:00
}
getPlacements() {
const { builtinPlacements, arrowPointAtCenter, autoAdjustOverflow } = this.props;
return builtinPlacements || getPlacements({
arrowPointAtCenter,
verticalArrowShift: 8,
autoAdjustOverflow,
});
}
isHoverTrigger() {
const { trigger } = this.props;
if (!trigger || trigger === 'hover') {
return true;
}
if (Array.isArray(trigger)) {
return trigger.indexOf('hover') >= 0;
}
return false;
}
// Fix Tooltip won't hide at disabled button
// mouse events don't trigger at disabled button in Chrome
// https://github.com/react-component/tooltip/issues/18
getDisabledCompatibleChildren(element) {
if ((element.type.__ANT_BUTTON || element.type === 'button') &&
element.props.disabled && this.isHoverTrigger()) {
// Pick some layout related style properties up to span
// Prevent layout bugs like https://github.com/ant-design/ant-design/issues/5254
const { picked, omited } = splitObject(
element.props.style,
['position', 'left', 'right', 'top', 'bottom', 'float', 'display', 'zIndex'],
);
const spanStyle = {
display: 'inline-block', // default inline-block is important
...picked,
cursor: 'not-allowed',
};
const buttonStyle = {
...omited,
pointerEvents: 'none',
};
const child = cloneElement(element, {
style: buttonStyle,
className: null,
});
return (
<span style={spanStyle} className={element.props.className}>
{child}
</span>
);
}
return element;
}
isNoTitle() {
const { title, overlay } = this.props;
return !title && !overlay; // overlay for old version compatibility
}
2016-04-07 16:43:00 +08:00
// 动态设置动画点
2016-04-07 15:02:22 +08:00
onPopupAlign = (domNode, align) => {
const placements = this.getPlacements();
2016-04-07 16:43:00 +08:00
// 当前返回的位置
const placement = Object.keys(placements).filter(
key => (
placements[key].points[0] === align.points[0] &&
placements[key].points[1] === align.points[1]
),
2016-04-07 16:43:00 +08:00
)[0];
if (!placement) {
return;
}
// 根据当前坐标设置动画点
2016-04-07 15:02:22 +08:00
const rect = domNode.getBoundingClientRect();
2016-04-07 16:43:00 +08:00
const transformOrigin = {
top: '50%',
left: '50%',
};
2016-04-07 15:02:22 +08:00
if (placement.indexOf('top') >= 0 || placement.indexOf('Bottom') >= 0) {
2016-04-07 16:43:00 +08:00
transformOrigin.top = `${rect.height - align.offset[1]}px`;
2016-04-07 15:02:22 +08:00
} else if (placement.indexOf('Top') >= 0 || placement.indexOf('bottom') >= 0) {
2016-04-07 16:43:00 +08:00
transformOrigin.top = `${-align.offset[1]}px`;
2016-04-07 15:02:22 +08:00
}
if (placement.indexOf('left') >= 0 || placement.indexOf('Right') >= 0) {
2016-04-07 16:43:00 +08:00
transformOrigin.left = `${rect.width - align.offset[0]}px`;
2016-04-07 15:02:22 +08:00
} else if (placement.indexOf('right') >= 0 || placement.indexOf('Left') >= 0) {
2016-04-07 16:43:00 +08:00
transformOrigin.left = `${-align.offset[0]}px`;
2016-04-07 15:02:22 +08:00
}
2016-04-07 16:43:00 +08:00
domNode.style.transformOrigin = `${transformOrigin.left} ${transformOrigin.top}`;
2016-04-07 16:56:13 +08:00
}
2016-04-07 15:02:22 +08:00
saveTooltip = (node) => {
this.tooltip = node;
}
2016-04-07 15:02:22 +08:00
render() {
2016-11-30 16:43:35 +08:00
const { props, state } = this;
const { prefixCls, title, overlay, openClassName, getPopupContainer, getTooltipContainer } = props;
2016-12-19 14:01:52 +08:00
const children = props.children as React.ReactElement<any>;
2016-11-30 16:43:35 +08:00
let visible = state.visible;
// Hide tooltip when there is no title
if (!('visible' in props) && this.isNoTitle()) {
visible = false;
}
2016-08-24 16:09:55 +08:00
const child = this.getDisabledCompatibleChildren(
React.isValidElement(children) ? children : <span>{children}</span>,
);
const childProps = child.props;
const childCls = classNames(childProps.className, {
2016-11-30 16:43:35 +08:00
[openClassName || `${prefixCls}-open`]: true,
2016-08-24 16:09:55 +08:00
});
2015-06-10 17:59:32 +08:00
return (
2016-05-07 15:37:26 +08:00
<RcTooltip
2016-06-22 22:54:54 +08:00
{...this.props}
getTooltipContainer={getPopupContainer || getTooltipContainer}
ref={this.saveTooltip}
2016-08-31 14:34:26 +08:00
builtinPlacements={this.getPlacements()}
overlay={overlay || title || ''}
visible={visible}
2016-06-22 22:54:54 +08:00
onVisibleChange={this.onVisibleChange}
onPopupAlign={this.onPopupAlign}
>
{visible ? cloneElement(child, { className: childCls }) : child}
</RcTooltip>
2015-06-03 17:08:43 +08:00
);
}
}