import * as React from 'react'; import RcTooltip from '@rc-component/tooltip'; import type { placements as Placements } from '@rc-component/tooltip/lib/placements'; import type { TooltipProps as RcTooltipProps, TooltipRef as RcTooltipRef, } from '@rc-component/tooltip/lib/Tooltip'; import type { BuildInPlacements } from '@rc-component/trigger'; import useMergedState from '@rc-component/util/lib/hooks/useMergedState'; import classNames from 'classnames'; import type { PresetColorType } from '../_util/colors'; import ContextIsolator from '../_util/ContextIsolator'; import type { RenderFunction } from '../_util/getRenderPropValue'; import { useZIndex } from '../_util/hooks/useZIndex'; import { getTransitionName } from '../_util/motion'; import type { AdjustOverflow, PlacementsConfig } from '../_util/placements'; import getPlacements from '../_util/placements'; import { cloneElement, isFragment } from '../_util/reactNode'; import type { LiteralUnion } from '../_util/type'; import { devUseWarning } from '../_util/warning'; import zIndexContext from '../_util/zindexContext'; import { useComponentConfig } from '../config-provider/context'; import { useToken } from '../theme/internal'; import useMergedArrow from './hook/useMergedArrow'; import PurePanel from './PurePanel'; import useStyle from './style'; import { parseColor } from './util'; export type { AdjustOverflow, PlacementsConfig }; export interface TooltipRef { forceAlign: VoidFunction; /** Wrapped dom element. Not promise valid if child not support ref */ nativeElement: HTMLElement; /** Popup dom element */ popupElement: HTMLDivElement; } 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' | 'destroyTooltipOnHide' > > { open?: RcTooltipProps['visible']; defaultOpen?: RcTooltipProps['defaultVisible']; onOpenChange?: RcTooltipProps['onVisibleChange']; afterOpenChange?: RcTooltipProps['afterVisibleChange']; } type SemanticName = 'root' | 'body'; export interface AbstractTooltipProps extends LegacyTooltipProps { styles?: Partial>; classNames?: Partial>; style?: React.CSSProperties; className?: string; rootClassName?: string; color?: LiteralUnion; placement?: TooltipPlacement; builtinPlacements?: typeof Placements; openClassName?: string; arrow?: boolean | { pointAtCenter?: boolean }; autoAdjustOverflow?: boolean | AdjustOverflow; getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement; children?: React.ReactNode; /** @deprecated Please use `destroyOnHidden` instead */ destroyTooltipOnHide?: boolean | { keepParent?: boolean }; /** * @since 5.25.0 */ destroyOnHidden?: boolean; } 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 InternalTooltip = React.forwardRef((props, ref) => { const { prefixCls: customizePrefixCls, openClassName, getTooltipContainer, color, overlayInnerStyle, children, afterOpenChange, arrow: tooltipArrow, destroyTooltipOnHide, destroyOnHidden, title, overlay, builtinPlacements, autoAdjustOverflow = true, motion, getPopupContainer, placement = 'top', mouseEnterDelay = 0.1, mouseLeaveDelay = 0.1, overlayStyle, rootClassName, overlayClassName, styles, classNames: tooltipClassNames, onOpenChange, ...restProps } = props; const [, token] = useToken(); const { getPopupContainer: getContextPopupContainer, getPrefixCls, direction, className: contextClassName, style: contextStyle, classNames: contextClassNames, styles: contextStyles, arrow: contextArrow, } = useComponentConfig('tooltip'); const mergedArrow = useMergedArrow(tooltipArrow, contextArrow); const mergedShowArrow = mergedArrow.show; // ============================== Ref =============================== const warning = devUseWarning('Tooltip'); const tooltipRef = React.useRef(null); const forceAlign = () => { tooltipRef.current?.forceAlign(); }; React.useImperativeHandle(ref, () => ({ forceAlign, nativeElement: tooltipRef.current?.nativeElement!, popupElement: tooltipRef.current?.popupElement!, })); // ============================== Warn ============================== if (process.env.NODE_ENV !== 'production') { [ ['overlayStyle', 'styles.root'], ['overlayInnerStyle', 'styles.body'], ['overlayClassName', 'classNames.root'], ['destroyTooltipOnHide', 'destroyOnHidden'], ].forEach(([deprecatedName, newName]) => { warning.deprecated(!(deprecatedName in props), deprecatedName, newName); }); warning( !destroyTooltipOnHide || typeof destroyTooltipOnHide === 'boolean', 'usage', '`destroyTooltipOnHide` no need config `keepParent` anymore. Please use `boolean` value directly.', ); } // ============================== Open ============================== const [open, setOpen] = useMergedState(false, { value: props.open, defaultValue: props.defaultOpen, }); const noTitle = !title && !overlay && title !== 0; // overlay for old version compatibility const onInternalOpenChange = (vis: boolean) => { setOpen(noTitle ? false : vis); if (!noTitle && onOpenChange) { onOpenChange(vis); } }; const tooltipPlacements = React.useMemo(() => { return ( builtinPlacements || getPlacements({ arrowPointAtCenter: mergedArrow?.pointAtCenter ?? false, autoAdjustOverflow, arrowWidth: mergedShowArrow ? token.sizePopupArrow : 0, borderRadius: token.borderRadius, offset: token.marginXXS, visibleFirst: true, }) ); }, [mergedArrow, builtinPlacements, token]); const memoOverlay = React.useMemo(() => { if (title === 0) { return title; } return overlay || title || ''; }, [overlay, title]); const memoOverlayWrapper = ( {typeof memoOverlay === 'function' ? memoOverlay() : memoOverlay} ); const prefixCls = getPrefixCls('tooltip', customizePrefixCls); const rootPrefixCls = getPrefixCls(); const injectFromPopover = (props as any)['data-popover-inject']; let tempOpen = open; // Hide tooltip when there is no title if (!('open' in props) && noTitle) { tempOpen = false; } // ============================= Render ============================= const child = React.isValidElement(children) && !isFragment(children) ? children : {children}; const childProps = child.props; const childCls = !childProps.className || typeof childProps.className === 'string' ? classNames(childProps.className, openClassName || `${prefixCls}-open`) : childProps.className; // Style const [hashId, cssVarCls] = useStyle(prefixCls, !injectFromPopover); // Color const colorInfo = parseColor(prefixCls, color); const arrowContentStyle = colorInfo.arrowStyle; const rootClassNames = classNames( overlayClassName, { [`${prefixCls}-rtl`]: direction === 'rtl' }, colorInfo.className, rootClassName, hashId, cssVarCls, contextClassName, contextClassNames.root, tooltipClassNames?.root, ); const bodyClassNames = classNames(contextClassNames.body, tooltipClassNames?.body); // ============================ zIndex ============================ const [zIndex, contextZIndex] = useZIndex('Tooltip', restProps.zIndex); const content = ( } motion={{ motionName: getTransitionName( rootPrefixCls, 'zoom-big-fast', typeof motion?.motionName === 'string' ? motion?.motionName : undefined, ), motionDeadline: 1000, }} destroyOnHidden={destroyOnHidden ?? !!destroyTooltipOnHide} > {tempOpen ? cloneElement(child, { className: childCls }) : child} ); return {content}; }); type CompoundedComponent = typeof InternalTooltip & { _InternalPanelDoNotUseOrYouWillBeFired: typeof PurePanel; }; const Tooltip = InternalTooltip as CompoundedComponent; if (process.env.NODE_ENV !== 'production') { Tooltip.displayName = 'Tooltip'; } Tooltip._InternalPanelDoNotUseOrYouWillBeFired = PurePanel; export default Tooltip;