ant-design-vue/components/tooltip/Tooltip.tsx

260 lines
8.2 KiB
Vue
Raw Normal View History

2021-06-26 01:35:40 +00:00
import type { ExtractPropTypes, CSSProperties } from 'vue';
import { computed, watch } from 'vue';
import { defineComponent, onMounted, ref } from 'vue';
2019-01-12 03:33:27 +00:00
import VcTooltip from '../vc-tooltip';
2020-08-31 08:53:19 +00:00
import classNames from '../_util/classNames';
2019-01-12 03:33:27 +00:00
import PropTypes from '../_util/vue-types';
import { PresetColorTypes } from '../_util/colors';
import warning from '../_util/warning';
import { getPropsSlot, getStyle, filterEmpty, isValidElement } from '../_util/props-util';
2020-06-10 10:20:57 +00:00
import { cloneElement } from '../_util/vnode';
import type { triggerTypes, placementTypes } from './abstractTooltipProps';
2019-01-12 03:33:27 +00:00
import abstractTooltipProps from './abstractTooltipProps';
import useConfigInject from '../_util/hooks/useConfigInject';
import getPlacements, { AdjustOverflow, PlacementsConfig } from './placements';
export { AdjustOverflow, PlacementsConfig };
2021-08-27 14:05:21 +00:00
export type TooltipPlacement = typeof placementTypes[number];
// 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;
}
2018-01-22 13:27:37 +00:00
2020-10-18 14:14:39 +00:00
const splitObject = (obj: any, keys: string[]) => {
2019-01-12 03:33:27 +00:00
const picked = {};
const omitted = { ...obj };
2018-01-22 13:27:37 +00:00
keys.forEach(key => {
if (obj && key in obj) {
2019-01-12 03:33:27 +00:00
picked[key] = obj[key];
delete omitted[key];
2018-01-22 13:27:37 +00:00
}
2019-01-12 03:33:27 +00:00
});
return { picked, omitted };
};
const props = abstractTooltipProps();
2020-10-24 14:38:25 +00:00
const PresetColorRegex = new RegExp(`^(${PresetColorTypes.join('|')})(-inverse)?$`);
2021-08-27 14:05:21 +00:00
export const tooltipProps = {
2020-10-24 14:38:25 +00:00
...props,
title: PropTypes.VNodeChild,
};
export type TriggerTypes = typeof triggerTypes[number];
export type PlacementTypes = typeof placementTypes[number];
2020-10-24 14:38:25 +00:00
export type TooltipProps = Partial<ExtractPropTypes<typeof tooltipProps>>;
2020-10-18 14:14:39 +00:00
export default defineComponent({
2018-04-08 13:17:20 +00:00
name: 'ATooltip',
2020-06-10 10:20:57 +00:00
inheritAttrs: false,
2020-10-24 14:38:25 +00:00
props: tooltipProps,
2020-10-18 14:14:39 +00:00
emits: ['update:visible', 'visibleChange'],
setup(props, { slots, emit, attrs, expose }) {
const { prefixCls, getTargetContainer } = useConfigInject('tooltip', props);
const visible = ref(false);
const tooltip = ref();
onMounted(() => {
warning(
!('default-visible' in attrs) || !('defaultVisible' in attrs),
'Tooltip',
`'defaultVisible' is deprecated, please use 'v-model:visible'`,
);
});
watch(
() => props.visible,
val => {
visible.value = !!val;
},
{ immediate: true },
);
const isNoTitle = () => {
const title = getPropsSlot(slots, props, 'title');
return !title && title !== 0;
2019-01-12 03:33:27 +00:00
};
const handleVisibleChange = (val: boolean) => {
2021-08-27 14:05:21 +00:00
const noTitle = isNoTitle();
if (props.visible === undefined) {
visible.value = noTitle ? false : val;
}
if (!noTitle) {
emit('update:visible', val);
emit('visibleChange', val);
2018-01-22 13:27:37 +00:00
}
};
2018-01-22 13:27:37 +00:00
const getPopupDomNode = () => {
return tooltip.value.getPopupDomNode();
};
2018-01-22 13:27:37 +00:00
2021-08-27 14:05:21 +00:00
expose({ getPopupDomNode, visible, forcePopupAlign: () => tooltip.value?.forcePopupAlign() });
const tooltipPlacements = computed(() => {
const { builtinPlacements, arrowPointAtCenter, autoAdjustOverflow } = props;
2019-01-12 03:33:27 +00:00
return (
builtinPlacements ||
getPlacements({
arrowPointAtCenter,
autoAdjustOverflow,
})
);
});
2018-01-22 13:27:37 +00:00
const getDisabledCompatibleChildren = (ele: any) => {
2019-01-12 03:33:27 +00:00
if (
2020-06-10 10:20:57 +00:00
((typeof ele.type === 'object' &&
(ele.type.__ANT_BUTTON === true ||
ele.type.__ANT_SWITCH === true ||
ele.type.__ANT_CHECKBOX === true)) ||
ele.type === 'button') &&
ele.props &&
(ele.props.disabled || ele.props.disabled === '')
2019-01-12 03:33:27 +00:00
) {
// 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',
]);
2018-01-22 13:27:37 +00:00
const spanStyle = {
display: 'inline-block', // default inline-block is important
...picked,
cursor: 'not-allowed',
2020-06-09 10:30:18 +00:00
width: ele.props && ele.props.block ? '100%' : null,
2019-01-12 03:33:27 +00:00
};
2018-01-22 13:27:37 +00:00
const buttonStyle = {
update to antd3.8.3 (#159) * refactor: align * feat: update align to 2.4.3 * feat: update trigger 2.5.4 * feat: update tooltip 3.7.2 * fix: align * feat: update vc-calendar to 9.6.2 * feat: update vc-checkbox to 2.1.5 * feat: update vc-dialog to 7.1.8 * feat: update vc-from to 2.2.1 * feat: update vc-notification to 3.1.1 * test: update snapshots * feat: update vc-tree to 1.12.6 * feat: update vc-table to 6.2.8 * feat: update vc-upload to 2.5.1 * feat: update vc-input-number to 4.0.12 * feat: update vc-tabs to 9.2.6 * refactor: vc-menu * refactor: update vc-menu to 7.0.5 * style: remove unused * feat: update pagination to 1.16.5 * feat: add vc-progress 2.2.5 tag * feat: add vc-rate 2.4.0 tag * feat: update vc-slider to 8.6.1 * fix: tooltip error * style: delete conosle * feat: update vc-steps to 3.1.1 * add vc-switch tag 1.6.0 * feat: update upload to 2.5.1 * fix: update vc-menu * fix: update store * fix: add ref dir * fix: trigger mock shouldComponentUpdate * fix: update vc-select * revert: trigger lazyrenderbox * fix: update vc-select * fix: update vc-select * fix: update vc-select * fix: update vc-menu * fix: update vc-slick ref * update style to 3.8.2 * test: update snapshots * update vc-select * update util & affix * feat: add drawer * fix: support title add slot mode * test: update affix test * update alert * update anchor * update snapshots * fix: doc and vc-drawer * update select & auto-complete * update back-top & grid * feractor: avatar * test: add drawer test * update badge * update button * update card * update divider * feat: update vc-tabs to 9.3.6 and tabs * add afterEnter callback * update form * fix: update drawer * test: update snapshots * update modal & notification * test: update snapshots * update message * update locale-provider * update dropdown * update layout popconfirm popover * update time-picker * update menu * update date-picker * docs: update input docs * update input * update snapshots * update table * update test snapshots * feat: update progress * update checkbox * feat: update spin * update radio * docs: slider steps timeline * update list * update transfer * update collapse * update cascader * update upload
2018-09-05 13:28:54 +00:00
...omitted,
2018-01-22 13:27:37 +00:00
pointerEvents: 'none',
2019-01-12 03:33:27 +00:00
};
2020-06-10 10:20:57 +00:00
const child = cloneElement(
ele,
{
style: buttonStyle,
},
true,
2019-01-12 03:33:27 +00:00
);
return (
<span style={spanStyle} class={`${prefixCls}-disabled-compatible-wrapper`}>
{child}
</span>
);
2018-01-22 13:27:37 +00:00
}
2019-01-12 03:33:27 +00:00
return ele;
};
Feat 1.5.0 (#1853) * feat: add Result component * fix: update md template tag html>tpl - fix `result` typo - update jest `result` snapshots * refactor: svg file to functional component icon - update jest snapshot * feat: add result * Feat descriptions (#1251) * feat: add descriptions * fix: add descriptions types and fix docs * fix: lint change code * fix: demo warning * fix: update demo, snapshot and remove classnames * test: add descriptions test * fix: descriptions demo (#1498) * feat: add page header (#1250) * feat: add page-header component * update site: page-header * ts definition update: page-header * get page-header props with getComponentFromProp func * optimize page-header * doc: add page-header actions.md responsive.md * breadcrumb itemRender add pure function support * style: format code * feat: update style to 3.23.6 from 2.13.6 * feat: update style to 3.26.8 from 3.23.6 * chore: update util * chore: update util * feat: update affix * feat: update alert * feat: update anchor * feat: update auto-complete * feat: update avatar * feat: update back-top * feat: update badge * feat: update button * feat: update breadcrumb * feat: update ts * docs: update doc * feat: update calendat * feat: update card * feat: update carousel * feat: update carousel * feat: update checkbox * feat: update comment * feat: update config-provider * docs: update doc * feat: update collapse * feat: update locale * feat: update date-picker * feat: update divider * feat: update drawer * feat: update dropdown * feat: update rc-trigger * feat: update dropdown * feat: update empty * test: add empty test * feat: update form * feat: update form * feat: update spin * feat: update grid * docs: update grid doc * feat: update icon * feat: update slider * feat: update textarea * feat: update input-number * feat: update layout * feat: update list * feat: update menu * feat: meaage add key for update content * feat: modal add closeIcon support * feat: update notification * feat: add pagination disabled support * feat: popconfirm add disabled support * test: update popover * feat: progress support custom line-gradiend * feat: update radio * test: update radio test * docs: update rate demo * feat: skeleton add avatar support number type * test: add switch test * test: update statistic test * fix: input clear icon event * feat: steps add type、 v-model、subTitle * feat: delete typography component * feat: delete Typography style * perf: update select * feat: add download transformFile previewFile actio * docs: update upload * feat: update tree-select * docs: update tree-select * feat: tree add blockNode selectable * docs: add tree demo * test: update snap * docs: updatedoc * feat: update tag * docs: update ad doc * feat: update tooltip * feat: update timeline * feat: time-picker add clearIcon * docs: update tabs * feat: transfer support custom children * test: update transfer test * feat: update table * test: update table test * test: update test * feat: calendar update locale * test: update test snap * feat: add mentions (#1790) * feat: mentions style * feat: theme default * feat: add mentions component * feat: mentions API * feat: add unit test for mentions * feat: update mentions demo * perf: model and inheritAttrs for mentions * perf: use getComponentFromProp instead of this.$props * perf: mentions rm defaultProps * feat: rm rows in mentionsProps * fix: mentions keyDown didn't work * docs: update mentions api * perf: mentions code * feat: update mentions * bump 1.5.0-alpha.1 * feat: pageheader add ghost prop * docs: update descriptions demo * chore: page-header add ghost type * fix: color error * feat: update to 3.26.12 * fix: some prop default value * fix(typo): form, carousel, upload. duplicate identifier (#1848) * Add Mentions Type (#1845) * feat: add mentions type * feat: add mentions in ant-design-vue.d.ts * docs: update doc * docs: add changelog * fix: mentions getPopupCotainer value (#1850) * docs: update doc * docs: uptate demo * docs: update demo * docs: delete demo * docs: delete doc * test: update snapshots * style: format code * chore: update travis * docs: update demo Co-authored-by: Sendya <18x@loacg.com> Co-authored-by: zkwolf <chenhao5866@gmail.com> Co-authored-by: drafish <xwlyy1991@163.com> Co-authored-by: Amour1688 <31695475+Amour1688@users.noreply.github.com>
2020-03-07 11:45:13 +00:00
const getOverlay = () => {
const title = getPropsSlot(slots, props, 'title');
return title ?? '';
};
2018-01-22 13:27:37 +00:00
const onPopupAlign = (domNode: HTMLElement, align: any) => {
const placements = tooltipPlacements.value;
2018-01-22 13:27:37 +00:00
// 当前返回的位置
const placement = Object.keys(placements).filter(
2019-01-12 03:33:27 +00:00
key =>
2018-01-22 13:27:37 +00:00
placements[key].points[0] === align.points[0] &&
2019-01-12 03:33:27 +00:00
placements[key].points[1] === align.points[1],
)[0];
2018-01-22 13:27:37 +00:00
if (!placement) {
2019-01-12 03:33:27 +00:00
return;
2018-01-22 13:27:37 +00:00
}
// 根据当前坐标设置动画点
2019-01-12 03:33:27 +00:00
const rect = domNode.getBoundingClientRect();
2018-01-22 13:27:37 +00:00
const transformOrigin = {
top: '50%',
left: '50%',
2019-01-12 03:33:27 +00:00
};
2018-01-22 13:27:37 +00:00
if (placement.indexOf('top') >= 0 || placement.indexOf('Bottom') >= 0) {
2019-01-12 03:33:27 +00:00
transformOrigin.top = `${rect.height - align.offset[1]}px`;
2018-01-22 13:27:37 +00:00
} else if (placement.indexOf('Top') >= 0 || placement.indexOf('bottom') >= 0) {
2019-01-12 03:33:27 +00:00
transformOrigin.top = `${-align.offset[1]}px`;
2018-01-22 13:27:37 +00:00
}
if (placement.indexOf('left') >= 0 || placement.indexOf('Right') >= 0) {
2019-01-12 03:33:27 +00:00
transformOrigin.left = `${rect.width - align.offset[0]}px`;
2018-01-22 13:27:37 +00:00
} else if (placement.indexOf('right') >= 0 || placement.indexOf('Left') >= 0) {
2019-01-12 03:33:27 +00:00
transformOrigin.left = `${-align.offset[0]}px`;
2018-01-22 13:27:37 +00:00
}
2019-01-12 03:33:27 +00:00
domNode.style.transformOrigin = `${transformOrigin.left} ${transformOrigin.top}`;
};
2018-01-22 13:27:37 +00:00
return () => {
const { openClassName, getPopupContainer, color, overlayClassName } = props;
let children = filterEmpty(slots.default?.()) ?? null;
children = children.length === 1 ? children[0] : children;
let tempVisible = visible.value;
// Hide tooltip when there is no title
if (props.visible === undefined && isNoTitle()) {
tempVisible = false;
}
if (!children) {
return null;
}
const child = getDisabledCompatibleChildren(
isValidElement(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}-${color}`]: color && PresetColorRegex.test(color),
});
let formattedOverlayInnerStyle: CSSProperties;
let arrowContentStyle: CSSProperties;
if (color && !PresetColorRegex.test(color)) {
formattedOverlayInnerStyle = { backgroundColor: color };
arrowContentStyle = { backgroundColor: color };
}
const vcTooltipProps = {
...attrs,
2021-08-28 13:57:12 +00:00
...(props as TooltipProps),
prefixCls: prefixCls.value,
getTooltipContainer: getPopupContainer || getTargetContainer.value,
builtinPlacements: tooltipPlacements.value,
overlay: getOverlay(),
visible: tempVisible,
ref: tooltip,
overlayClassName: customOverlayClassName,
overlayInnerStyle: formattedOverlayInnerStyle,
onVisibleChange: handleVisibleChange,
onPopupAlign,
};
return (
<VcTooltip
{...vcTooltipProps}
v-slots={{
arrowContent: () => (
<span class={`${prefixCls.value}-arrow-content`} style={arrowContentStyle}></span>
),
}}
>
{visible.value ? cloneElement(child, { class: childCls }) : child}
</VcTooltip>
);
2019-01-12 03:33:27 +00:00
};
2018-01-22 13:27:37 +00:00
},
2020-10-18 14:14:39 +00:00
});