import classNames from 'classnames'; import RcTooltip from 'rc-tooltip'; import type { placements as Placements } from 'rc-tooltip/lib/placements'; import type { TooltipProps as RcTooltipProps } from 'rc-tooltip/lib/Tooltip'; import type { AlignType } from 'rc-trigger/lib/interface'; import useMergedState from 'rc-util/lib/hooks/useMergedState'; import * as React from 'react'; import { ConfigContext } from '../config-provider'; import type { PresetColorType } from '../_util/colors'; import { PresetColorTypes } from '../_util/colors'; import { getTransitionName } from '../_util/motion'; import getPlacements, { AdjustOverflow, PlacementsConfig } from '../_util/placements'; import { cloneElement, isValidElement, isFragment } from '../_util/reactNode'; import type { LiteralUnion } from '../_util/type'; import warning from '../_util/warning'; export { AdjustOverflow, PlacementsConfig }; export type TooltipPlacement = | 'top' | 'left' | 'right' | 'bottom' | 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight' | 'leftTop' | 'leftBottom' | 'rightTop' | 'rightBottom'; // https://github.com/react-component/tooltip // https://github.com/yiminghe/dom-align export interface TooltipAlignConfig { points?: [string, string]; offset?: [number | string, number | string]; targetOffset?: [number | string, number | string]; overflow?: { adjustX: boolean; adjustY: boolean }; useCssRight?: boolean; useCssBottom?: boolean; useCssTransform?: boolean; } // remove this after RcTooltip switch visible to open. interface LegacyTooltipProps extends Partial< Omit< RcTooltipProps, 'children' | 'visible' | 'defaultVisible' | 'onVisibleChange' | 'afterVisibleChange' > > { /** * @deprecated `visible` is deprecated which will be removed in next major version. Please use * `open` instead. */ visible?: RcTooltipProps['visible']; open?: RcTooltipProps['visible']; /** * @deprecated `defaultVisible` is deprecated which will be removed in next major version. Please * use `defaultOpen` instead. */ defaultVisible?: RcTooltipProps['defaultVisible']; defaultOpen?: RcTooltipProps['defaultVisible']; /** * @deprecated `onVisibleChange` is deprecated which will be removed in next major version. Please * use `onOpenChange` instead. */ onVisibleChange?: RcTooltipProps['onVisibleChange']; onOpenChange?: RcTooltipProps['onVisibleChange']; /** * @deprecated `afterVisibleChange` is deprecated which will be removed in next major version. * Please use `afterOpenChange` instead. */ afterVisibleChange?: RcTooltipProps['afterVisibleChange']; afterOpenChange?: RcTooltipProps['afterVisibleChange']; } export interface AbstractTooltipProps extends LegacyTooltipProps { style?: React.CSSProperties; className?: string; color?: LiteralUnion; placement?: TooltipPlacement; builtinPlacements?: typeof Placements; openClassName?: string; arrowPointAtCenter?: boolean; autoAdjustOverflow?: boolean | AdjustOverflow; getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement; children?: React.ReactNode; } export type RenderFunction = () => React.ReactNode; export interface TooltipPropsWithOverlay extends AbstractTooltipProps { title?: React.ReactNode | RenderFunction; overlay?: React.ReactNode | RenderFunction; } export interface TooltipPropsWithTitle extends AbstractTooltipProps { title: React.ReactNode | RenderFunction; overlay?: React.ReactNode | RenderFunction; } export declare type TooltipProps = TooltipPropsWithTitle | TooltipPropsWithOverlay; const splitObject = ( obj: T, keys: (keyof T)[], ): Record<'picked' | 'omitted', T> => { const picked: T = {} as T; const omitted: T = { ...obj }; keys.forEach(key => { if (obj && key in obj) { picked[key] = obj[key]; delete omitted[key]; } }); return { picked, omitted }; }; const PresetColorRegex = new RegExp(`^(${PresetColorTypes.join('|')})(-inverse)?$`); // 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 function getDisabledCompatibleChildren(element: React.ReactElement, prefixCls: string) { const elementType = element.type as any; if ( ((elementType.__ANT_BUTTON === true || element.type === 'button') && element.props.disabled) || (elementType.__ANT_SWITCH === true && (element.props.disabled || element.props.loading)) || (elementType.__ANT_RADIO === true && element.props.disabled) ) { // Pick some layout related style properties up to span // Prevent layout bugs like https://github.com/ant-design/ant-design/issues/5254 const { picked, omitted } = splitObject(element.props.style, [ 'position', 'left', 'right', 'top', 'bottom', 'float', 'display', 'zIndex', ]); const spanStyle: React.CSSProperties = { display: 'inline-block', // default inline-block is important ...picked, cursor: 'not-allowed', width: element.props.block ? '100%' : undefined, }; const buttonStyle: React.CSSProperties = { ...omitted, pointerEvents: 'none', }; const child = cloneElement(element, { style: buttonStyle, className: null, }); return ( {child} ); } return element; } const Tooltip = React.forwardRef((props, ref) => { const { getPopupContainer: getContextPopupContainer, getPrefixCls, direction, } = React.useContext(ConfigContext); // Warning for deprecated usage if (process.env.NODE_ENV !== 'production') { [ ['visible', 'open'], ['defaultVisible', 'defaultOpen'], ['onVisibleChange', 'onOpenChange'], ['afterVisibleChange', 'afterOpenChange'], ].forEach(([deprecatedName, newName]) => { warning( !(deprecatedName in props), 'Tooltip', `\`${deprecatedName}\` is deprecated which will be removed in next major version, please use \`${newName}\` instead.`, ); }); } const [open, setOpen] = useMergedState(false, { value: props.open !== undefined ? props.open : props.visible, defaultValue: props.defaultOpen !== undefined ? props.defaultOpen : props.defaultVisible, }); const isNoTitle = () => { const { title, overlay } = props; return !title && !overlay && title !== 0; // overlay for old version compatibility }; const onOpenChange = (vis: boolean) => { setOpen(isNoTitle() ? false : vis); if (!isNoTitle()) { props.onOpenChange?.(vis); props.onVisibleChange?.(vis); } }; const getTooltipPlacements = () => { const { builtinPlacements, arrowPointAtCenter = false, autoAdjustOverflow = true } = props; return ( builtinPlacements || getPlacements({ arrowPointAtCenter, autoAdjustOverflow, }) ); }; // 动态设置动画点 const onPopupAlign = (domNode: HTMLElement, align: AlignType) => { const placements = getTooltipPlacements(); // 当前返回的位置 const placement = Object.keys(placements).find( key => placements[key].points![0] === align.points?.[0] && placements[key].points![1] === align.points?.[1], ); if (!placement) { return; } // 根据当前坐标设置动画点 const rect = domNode.getBoundingClientRect(); const transformOrigin = { top: '50%', left: '50%' }; if (/top|Bottom/.test(placement)) { transformOrigin.top = `${rect.height - align.offset![1]}px`; } else if (/Top|bottom/.test(placement)) { transformOrigin.top = `${-align.offset![1]}px`; } if (/left|Right/.test(placement)) { transformOrigin.left = `${rect.width - align.offset![0]}px`; } else if (/right|Left/.test(placement)) { transformOrigin.left = `${-align.offset![0]}px`; } domNode.style.transformOrigin = `${transformOrigin.left} ${transformOrigin.top}`; }; const getOverlay = () => { const { title, overlay } = props; if (title === 0) { return title; } return overlay || title || ''; }; const { getPopupContainer, placement = 'top', mouseEnterDelay = 0.1, mouseLeaveDelay = 0.1, ...otherProps } = props; const { prefixCls: customizePrefixCls, openClassName, getTooltipContainer, overlayClassName, color, overlayInnerStyle, children, } = props; const prefixCls = getPrefixCls('tooltip', customizePrefixCls); const rootPrefixCls = getPrefixCls(); let tempOpen = open; // Hide tooltip when there is no title if (!('open' in props) && !('visible' in props) && isNoTitle()) { tempOpen = false; } const child = getDisabledCompatibleChildren( isValidElement(children) && !isFragment(children) ? children : {children}, prefixCls, ); const childProps = child.props; const childCls = !childProps.className || typeof childProps.className === 'string' ? classNames(childProps.className, { [openClassName || `${prefixCls}-open`]: true, }) : childProps.className; const customOverlayClassName = classNames(overlayClassName, { [`${prefixCls}-rtl`]: direction === 'rtl', [`${prefixCls}-${color}`]: color && PresetColorRegex.test(color), }); let formattedOverlayInnerStyle = overlayInnerStyle; let arrowContentStyle: React.CSSProperties = {}; if (color && !PresetColorRegex.test(color)) { formattedOverlayInnerStyle = { ...overlayInnerStyle, background: color }; // @ts-ignore arrowContentStyle = { '--antd-arrow-background-color': color }; } return ( } motion={{ motionName: getTransitionName(rootPrefixCls, 'zoom-big-fast', props.transitionName), motionDeadline: 1000, }} > {tempOpen ? cloneElement(child, { className: childCls }) : child} ); }); if (process.env.NODE_ENV !== 'production') { Tooltip.displayName = 'Tooltip'; } export default Tooltip;