ant-design/components/tooltip/__tests__/tooltip.test.tsx
lijianan c34caad24c
test: js => ts (#37392)
* test: js => ts

* test: add test

* fix: fix eslint error

* test: add test case

* fix: fix test error

* fix: fix eslint error

* fix: fix eslint error

* fix: eslint error fix

* fix: fallback eslint config & add test case

* test: add all test case

* fix: bugfix

* fix: bugFix

* fix: bugFix

* fix: bugFix

* fix: lint

* fix: add React.createRef

* fix: add breadcrumbName in Routes

* fix: any commit for restart ci/cd

* fix: remove type

* fix: test fix

* fix: test fix

* fix: add ts-ignore for id

* test: add Icon test case

* test: remove ts-ignore

* test: add Icon test case
2022-09-05 19:41:32 +08:00

537 lines
17 KiB
TypeScript

import { spyElementPrototype } from 'rc-util/lib/test/domHook';
import React from 'react';
import type { TooltipPlacement } from '..';
import Tooltip from '..';
import mountTest from '../../../tests/shared/mountTest';
import rtlTest from '../../../tests/shared/rtlTest';
import { fireEvent, render, sleep, waitFor } from '../../../tests/utils';
import Button from '../../button';
import DatePicker from '../../date-picker';
import Input from '../../input';
import Group from '../../input/Group';
import Switch from '../../switch';
import Radio from '../../radio';
describe('Tooltip', () => {
mountTest(Tooltip);
rtlTest(Tooltip);
beforeAll(() => {
spyElementPrototype(HTMLElement, 'offsetParent', {
get: () => ({}),
});
});
it('check `onOpenChange` arguments', () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container, rerender } = render(
<Tooltip
title=""
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<div id="hello">Hello world!</div>
</Tooltip>,
);
// `title` is empty.
const divElement = container.querySelector('#hello');
fireEvent.mouseEnter(divElement!);
expect(onOpenChange).not.toHaveBeenCalled();
expect(onVisibleChange).not.toHaveBeenCalled();
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
fireEvent.mouseLeave(divElement!);
expect(onOpenChange).not.toHaveBeenCalled();
expect(onVisibleChange).not.toHaveBeenCalled();
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
// update `title` value.
rerender(
<Tooltip
title="Have a nice day!"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<div id="hello">Hello world!</div>
</Tooltip>,
);
fireEvent.mouseEnter(divElement!);
expect(onOpenChange).toHaveBeenLastCalledWith(true);
expect(onVisibleChange).toHaveBeenLastCalledWith(true);
expect(ref.current.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(divElement!);
expect(onOpenChange).toHaveBeenLastCalledWith(false);
expect(onVisibleChange).toHaveBeenLastCalledWith(false);
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
// add `open` props.
rerender(
<Tooltip
title="Have a nice day!"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
open={false}
>
<div id="hello">Hello world!</div>
</Tooltip>,
);
fireEvent.mouseEnter(divElement!);
expect(onOpenChange).toHaveBeenLastCalledWith(true);
expect(onVisibleChange).toHaveBeenLastCalledWith(true);
const lastCount = onOpenChange.mock.calls.length;
expect(ref.current.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
// always trigger onOpenChange
fireEvent.mouseLeave(divElement!);
expect(onOpenChange.mock.calls.length).toBe(lastCount); // no change with lastCount
expect(onVisibleChange.mock.calls.length).toBe(lastCount);
expect(ref.current.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
it('should hide when mouse leave native disabled button', () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container } = render(
<Tooltip
title="xxxxx"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<button type="button" disabled>
Hello world!
</button>
</Tooltip>,
);
expect(container.getElementsByTagName('span')).toHaveLength(1);
const button = container.getElementsByTagName('span')[0];
fireEvent.mouseEnter(button);
expect(onOpenChange).toHaveBeenCalledWith(true);
expect(onVisibleChange).toHaveBeenCalledWith(true);
expect(ref.current?.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(button);
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(onVisibleChange).toHaveBeenCalledWith(false);
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
describe('should hide when mouse leave antd disabled component', () => {
function testComponent(name: string, Component: typeof Button | typeof Switch) {
it(name, () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container } = render(
<Tooltip
title="xxxxx"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<Component disabled />
</Tooltip>,
);
expect(container.children[0]).toMatchSnapshot();
const button = container.getElementsByTagName('span')[0];
fireEvent.mouseEnter(button);
expect(onOpenChange).toHaveBeenCalledWith(true);
expect(onVisibleChange).toHaveBeenCalledWith(true);
expect(ref.current?.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(button);
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(onVisibleChange).toHaveBeenCalledWith(false);
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
}
testComponent('Button', Button);
testComponent('Switch', Switch);
});
it('should render disabled Button style properly', () => {
const { container: containerInline } = render(
<Tooltip title="xxxxx">
<Button disabled>Hello world!</Button>
</Tooltip>,
);
const { container: containerBlock } = render(
<Tooltip title="xxxxx">
<Button disabled style={{ display: 'block' }}>
Hello world!
</Button>
</Tooltip>,
);
expect(containerInline.getElementsByTagName('span')[0].style.display).toBe('inline-block');
expect(containerBlock.getElementsByTagName('span')[0].style.display).toBe('block');
});
it('should works for arrowPointAtCenter', () => {
const arrowWidth = 5;
const horizontalArrowShift = 16;
const triggerWidth = 200;
const suit = () => {
const { container } = render(
<Tooltip
title="xxxxx"
trigger="click"
mouseEnterDelay={0}
mouseLeaveDelay={0}
placement="bottomLeft"
overlayClassName="default-element"
>
<button type="button" style={{ width: triggerWidth }}>
Hello world!
</button>
</Tooltip>,
);
fireEvent.click(container.getElementsByTagName('button')[0]);
const popupLeftDefault = parseInt(
container.querySelector<HTMLDivElement>('.default-element')?.style?.left!,
10,
);
const { container: container2 } = render(
<Tooltip
title="xxxxx"
trigger="click"
mouseEnterDelay={0}
mouseLeaveDelay={0}
placement="bottomLeft"
arrowPointAtCenter
overlayClassName="point-center-element"
>
<button type="button" style={{ width: triggerWidth }}>
Hello world!
</button>
</Tooltip>,
);
fireEvent.click(container2.getElementsByTagName('button')[0]);
const popupLeftArrowPointAtCenter = parseInt(
container.querySelector<HTMLDivElement>('.point-center-element')?.style?.left!,
10,
);
expect(popupLeftArrowPointAtCenter - popupLeftDefault).toBe(
triggerWidth / 2 - horizontalArrowShift - arrowWidth,
);
};
(jest.dontMock as any)('rc-trigger', suit);
});
it('should works for date picker', async () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container } = render(
<Tooltip
title="date picker"
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<DatePicker />
</Tooltip>,
);
expect(container.getElementsByClassName('ant-picker')).toHaveLength(1);
const picker = container.getElementsByClassName('ant-picker')[0];
fireEvent.mouseEnter(picker);
await sleep(100);
expect(onOpenChange).toHaveBeenCalledWith(true);
expect(onVisibleChange).toHaveBeenCalledWith(true);
expect(ref.current?.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(picker);
await sleep(100);
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(onVisibleChange).toHaveBeenCalledWith(false);
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
it('should works for input group', async () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container } = render(
<Tooltip
title="hello"
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<Group>
<Input style={{ width: '50%' }} />
<Input style={{ width: '50%' }} />
</Group>
</Tooltip>,
);
expect(container.getElementsByClassName('ant-input-group')).toHaveLength(1);
const inputGroup = container.getElementsByClassName('ant-input-group')[0];
fireEvent.mouseEnter(inputGroup);
await sleep(100);
expect(onOpenChange).toHaveBeenCalledWith(true);
expect(onVisibleChange).toHaveBeenCalledWith(true);
expect(ref.current?.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(inputGroup);
await sleep(100);
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(onVisibleChange).toHaveBeenCalledWith(false);
expect(ref.current?.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
// https://github.com/ant-design/ant-design/issues/20891
it('should display zero', () => {
const { container } = render(
<Tooltip title={0} open>
<div />
</Tooltip>,
);
expect(container.querySelector('.ant-tooltip-inner')?.innerHTML).toBe('0');
});
it('autoAdjustOverflow should be object or undefined', () => {
expect(() => {
render(
<Tooltip title={0} open autoAdjustOverflow={{ adjustX: 0, adjustY: 0 }}>
<div />
</Tooltip>,
);
}).not.toThrow();
expect(() => {
render(
<Tooltip title={0} open autoAdjustOverflow={undefined}>
<div />
</Tooltip>,
);
}).not.toThrow();
});
describe('support other placement when mouse enter', () => {
const placementList = [
'top',
'left',
'right',
'bottom',
'topLeft',
'topRight',
'bottomLeft',
'bottomRight',
'leftTop',
'leftBottom',
'rightTop',
'rightBottom',
] as const;
const testPlacement = (name: string, placement: TooltipPlacement) => {
it(name, async () => {
const { container } = render(
<Tooltip title="xxxxx" transitionName="" mouseEnterDelay={0} placement={placement}>
<span>Hello world!</span>
</Tooltip>,
);
expect(container.getElementsByTagName('span')).toHaveLength(1);
const element = container.getElementsByTagName('span')[0];
fireEvent.mouseEnter(element);
await sleep(500);
await waitFor(() => {
expect(document.querySelector(`.ant-tooltip-placement-${placement}`)).not.toBeNull();
});
});
};
placementList.forEach(placement => testPlacement(`Placement ${placement}`, placement));
});
it('should works for mismatch placement', async () => {
const { container } = render(
<Tooltip
title="xxxxx"
align={{
points: ['bc', 'tl'],
}}
mouseEnterDelay={0}
>
<span>Hello world!</span>
</Tooltip>,
);
const button = container.getElementsByTagName('span')[0];
fireEvent.mouseEnter(button);
await sleep(600);
expect(document.querySelector('.ant-tooltip')).not.toBeNull();
});
it('should pass overlayInnerStyle through to the inner component', () => {
const { container } = render(
<Tooltip overlayInnerStyle={{ color: 'red' }} title="xxxxx" visible>
<div />
</Tooltip>,
);
expect(container.querySelector<HTMLDivElement>('.ant-tooltip-inner')?.style?.color).toBe('red');
});
it('should work with loading switch', () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const { container } = render(
<Tooltip
title="loading tips"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
>
<Switch loading defaultChecked />
</Tooltip>,
);
const wrapperEl = container.querySelectorAll('.ant-tooltip-disabled-compatible-wrapper');
expect(wrapperEl).toHaveLength(1);
fireEvent.mouseEnter(container.getElementsByTagName('span')[0]);
expect(onOpenChange).toHaveBeenLastCalledWith(true);
expect(onVisibleChange).toHaveBeenLastCalledWith(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
});
it('should work with disabled Radio', () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const { container } = render(
<Tooltip
title="loading tips"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
>
<Radio disabled />
</Tooltip>,
);
const wrapperEl = container.querySelectorAll('.ant-tooltip-disabled-compatible-wrapper');
expect(wrapperEl).toHaveLength(1);
fireEvent.mouseEnter(container.getElementsByTagName('span')[0]);
expect(onOpenChange).toHaveBeenLastCalledWith(true);
expect(onVisibleChange).toHaveBeenLastCalledWith(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
});
it('should work with Fragment children', () => {
const onOpenChange = jest.fn();
const onVisibleChange = jest.fn();
const ref = React.createRef<any>();
const { container } = render(
<Tooltip
title="Have a nice day!"
mouseEnterDelay={0}
mouseLeaveDelay={0}
onOpenChange={onOpenChange}
onVisibleChange={onVisibleChange}
ref={ref}
>
<>
<div className="hello">Hello world!</div>
<div className="hello">Hello world!</div>
</>
</Tooltip>,
);
const divElement = container.querySelector('.hello');
fireEvent.mouseEnter(divElement!);
expect(onOpenChange).toHaveBeenLastCalledWith(true);
expect(onVisibleChange).toHaveBeenLastCalledWith(true);
expect(ref.current.props.visible).toBe(true);
expect(container.querySelector('.ant-tooltip-open')).not.toBeNull();
fireEvent.mouseLeave(divElement!);
expect(onOpenChange).toHaveBeenLastCalledWith(false);
expect(onVisibleChange).toHaveBeenLastCalledWith(false);
expect(ref.current.props.visible).toBe(false);
expect(container.querySelector('.ant-tooltip-open')).toBeNull();
});
it('deprecated warning', () => {
const errSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
const { rerender } = render(
<Tooltip visible>
<a />
</Tooltip>,
);
expect(errSpy).toHaveBeenCalledWith(
'Warning: [antd: Tooltip] `visible` is deprecated which will be removed in next major version, please use `open` instead.',
);
rerender(
<Tooltip defaultVisible>
<a />
</Tooltip>,
);
expect(errSpy).toHaveBeenCalledWith(
'Warning: [antd: Tooltip] `defaultVisible` is deprecated which will be removed in next major version, please use `defaultOpen` instead.',
);
rerender(
<Tooltip onVisibleChange={() => {}}>
<a />
</Tooltip>,
);
expect(errSpy).toHaveBeenCalledWith(
'Warning: [antd: Tooltip] `onVisibleChange` is deprecated which will be removed in next major version, please use `onOpenChange` instead.',
);
rerender(
<Tooltip afterVisibleChange={() => {}}>
<a />
</Tooltip>,
);
expect(errSpy).toHaveBeenCalledWith(
'Warning: [antd: Tooltip] `afterVisibleChange` is deprecated which will be removed in next major version, please use `afterOpenChange` instead.',
);
errSpy.mockRestore();
});
});