You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ant-design-vue/components/tooltip/Tooltip.tsx

315 lines
10 KiB

import type { CSSProperties, ExtractPropTypes } from 'vue';
import { computed, watch, defineComponent, ref } from 'vue';
import VcTooltip from '../vc-tooltip';
import classNames from '../_util/classNames';
import PropTypes from '../_util/vue-types';
import warning from '../_util/warning';
import {
getStyle,
filterEmpty,
isValidElement,
initDefaultProps,
isFragment,
} from '../_util/props-util';
import { cloneElement } from '../_util/vnode';
export type { TriggerType, TooltipPlacement } from './abstractTooltipProps';
import abstractTooltipProps from './abstractTooltipProps';
import useConfigInject from '../config-provider/hooks/useConfigInject';
import getPlacements from '../_util/placements';
import firstNotUndefined from '../_util/firstNotUndefined';
import raf from '../_util/raf';
import { parseColor } from './util';
export type { AdjustOverflow, PlacementsConfig } from '../_util/placements';
import useStyle from './style';
import { getTransitionName } from '../_util/transition';
import type { CustomSlotsType } from '../_util/type';
// 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;
}
const splitObject = <T extends CSSProperties>(
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 };
};
export const tooltipProps = () => ({
...abstractTooltipProps(),
title: PropTypes.any,
});
export const tooltipDefaultProps = () => ({
trigger: 'hover',
align: {},
placement: 'top',
mouseEnterDelay: 0.1,
mouseLeaveDelay: 0.1,
arrowPointAtCenter: false,
autoAdjustOverflow: true,
});
export type TooltipProps = Partial<ExtractPropTypes<ReturnType<typeof tooltipProps>>>;
export default defineComponent({
compatConfig: { MODE: 3 },
name: 'ATooltip',
inheritAttrs: false,
props: initDefaultProps(tooltipProps(), {
trigger: 'hover',
align: {},
placement: 'top',
mouseEnterDelay: 0.1,
mouseLeaveDelay: 0.1,
arrowPointAtCenter: false,
autoAdjustOverflow: true,
}),
slots: Object as CustomSlotsType<{
title?: any;
default?: any;
}>,
// emits: ['update:visible', 'visibleChange'],
setup(props, { slots, emit, attrs, expose }) {
if (process.env.NODE_ENV !== 'production') {
[
['visible', 'open'],
['onVisibleChange', 'onOpenChange'],
].forEach(([deprecatedName, newName]) => {
warning(
props[deprecatedName] === undefined,
'Tooltip',
`\`${deprecatedName}\` is deprecated, please use \`${newName}\` instead.`,
);
});
}
const { prefixCls, getPopupContainer, direction, rootPrefixCls } = useConfigInject(
'tooltip',
props,
);
const mergedOpen = computed(() => props.open ?? props.visible);
const innerOpen = ref(firstNotUndefined([props.open, props.visible]));
const tooltip = ref();
let rafId: any;
watch(mergedOpen, val => {
raf.cancel(rafId);
rafId = raf(() => {
innerOpen.value = !!val;
});
});
const isNoTitle = () => {
const title = props.title ?? slots.title;
return !title && title !== 0;
};
const handleVisibleChange = (val: boolean) => {
const noTitle = isNoTitle();
if (mergedOpen.value === undefined) {
innerOpen.value = noTitle ? false : val;
}
if (!noTitle) {
emit('update:visible', val);
emit('visibleChange', val);
emit('update:open', val);
emit('openChange', val);
}
};
const getPopupDomNode = () => {
return tooltip.value.getPopupDomNode();
};
expose({
getPopupDomNode,
open: innerOpen,
forcePopupAlign: () => tooltip.value?.forcePopupAlign(),
});
const tooltipPlacements = computed(() => {
const { builtinPlacements, arrowPointAtCenter, autoAdjustOverflow } = props;
return (
builtinPlacements ||
getPlacements({
arrowPointAtCenter,
autoAdjustOverflow,
})
);
});
const isTrueProps = (val: boolean | '') => {
return val || val === '';
};
const getDisabledCompatibleChildren = (ele: any) => {
const elementType = ele.type as any;
if (typeof elementType === 'object' && ele.props) {
if (
((elementType.__ANT_BUTTON === true || elementType === 'button') &&
isTrueProps(ele.props.disabled)) ||
(elementType.__ANT_SWITCH === true &&
(isTrueProps(ele.props.disabled) || isTrueProps(ele.props.loading))) ||
(elementType.__ANT_RADIO === true && isTrueProps(ele.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(getStyle(ele), [
'position',
'left',
'right',
'top',
'bottom',
'float',
'display',
'zIndex',
]);
const spanStyle: CSSProperties = {
display: 'inline-block', // default inline-block is important
...picked,
cursor: 'not-allowed',
lineHeight: 1, // use the true height of child nodes
width: ele.props && ele.props.block ? '100%' : undefined,
};
const buttonStyle: CSSProperties = {
...omitted,
pointerEvents: 'none',
};
const child = cloneElement(
ele,
{
style: buttonStyle,
},
true,
);
return (
<span style={spanStyle} class={`${prefixCls.value}-disabled-compatible-wrapper`}>
{child}
</span>
);
}
}
return ele;
};
const getOverlay = () => {
return props.title ?? slots.title?.();
};
const onPopupAlign = (domNode: HTMLElement, align: any) => {
const placements = tooltipPlacements.value;
// 当前返回的位置
const placement = Object.keys(placements).find(
key =>
placements[key].points[0] === align.points?.[0] &&
placements[key].points[1] === align.points?.[1],
);
if (placement) {
// 根据当前坐标设置动画点
const rect = domNode.getBoundingClientRect();
const transformOrigin = {
top: '50%',
left: '50%',
};
if (placement.indexOf('top') >= 0 || placement.indexOf('Bottom') >= 0) {
transformOrigin.top = `${rect.height - align.offset[1]}px`;
} else if (placement.indexOf('Top') >= 0 || placement.indexOf('bottom') >= 0) {
transformOrigin.top = `${-align.offset[1]}px`;
}
if (placement.indexOf('left') >= 0 || placement.indexOf('Right') >= 0) {
transformOrigin.left = `${rect.width - align.offset[0]}px`;
} else if (placement.indexOf('right') >= 0 || placement.indexOf('Left') >= 0) {
transformOrigin.left = `${-align.offset[0]}px`;
}
domNode.style.transformOrigin = `${transformOrigin.left} ${transformOrigin.top}`;
}
};
const colorInfo = computed(() => parseColor(prefixCls.value, props.color));
const injectFromPopover = computed(() => (attrs as any)['data-popover-inject']);
const [wrapSSR, hashId] = useStyle(
prefixCls,
computed(() => !injectFromPopover.value),
);
return () => {
const { openClassName, overlayClassName, overlayStyle, overlayInnerStyle } = props;
let children = filterEmpty(slots.default?.()) ?? null;
children = children.length === 1 ? children[0] : children;
let tempVisible = innerOpen.value;
// Hide tooltip when there is no title
if (mergedOpen.value === undefined && isNoTitle()) {
tempVisible = false;
}
if (!children) {
return null;
}
const child = getDisabledCompatibleChildren(
isValidElement(children) && !isFragment(children) ? children : <span>{children}</span>,
);
const childCls = classNames({
[openClassName || `${prefixCls.value}-open`]: true,
[child.props && child.props.class]: child.props && child.props.class,
});
const customOverlayClassName = classNames(
overlayClassName,
{
[`${prefixCls.value}-rtl`]: direction.value === 'rtl',
},
colorInfo.value.className,
hashId.value,
);
const formattedOverlayInnerStyle = {
...colorInfo.value.overlayStyle,
...overlayInnerStyle,
};
const arrowContentStyle = colorInfo.value.arrowStyle;
const vcTooltipProps = {
...attrs,
...(props as TooltipProps),
prefixCls: prefixCls.value,
getPopupContainer: getPopupContainer?.value,
builtinPlacements: tooltipPlacements.value,
visible: tempVisible,
ref: tooltip,
overlayClassName: customOverlayClassName,
overlayStyle: { ...arrowContentStyle, ...overlayStyle },
overlayInnerStyle: formattedOverlayInnerStyle,
onVisibleChange: handleVisibleChange,
onPopupAlign,
transitionName: getTransitionName(
rootPrefixCls.value,
'zoom-big-fast',
props.transitionName,
),
};
return wrapSSR(
<VcTooltip
{...vcTooltipProps}
v-slots={{
arrowContent: () => <span class={`${prefixCls.value}-arrow-content`}></span>,
overlay: getOverlay,
}}
>
{innerOpen.value ? cloneElement(child, { class: childCls }) : child}
</VcTooltip>,
);
};
},
});