Skip to content

Commit c9aa0cd

Browse files
fix(Menu): prevent tooltip flash when collapsing while hovered (#58865)
* fix(Menu): prevent tooltip flash when collapsing while hovered Co-authored-by: Cursor <[email protected]> * fix(Menu): respect controlled tooltip.open when collapsed Co-authored-by: Cursor <[email protected]> --------- Co-authored-by: Cursor <[email protected]>
1 parent 6b28e00 commit c9aa0cd

2 files changed

Lines changed: 60 additions & 3 deletions

File tree

‎components/menu/MenuItem.tsx‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,18 @@ const MenuItem: GenericComponent = (props) => {
4747
styles,
4848
classNames,
4949
} = React.useContext<MenuContextProps>(MenuContext);
50+
const { siderCollapsed } = React.useContext<SiderContextProps>(SiderContext);
51+
52+
const mergedCollapsed = !!(siderCollapsed || isInlineCollapsed);
53+
54+
// Controlled tooltip state to prevent flash during collapse/expand transitions
55+
// ref: https://github.com/ant-design/ant-design/issues/56528
56+
const [tooltipOpen, setTooltipOpen] = React.useState(false);
57+
58+
React.useEffect(() => {
59+
setTooltipOpen(false);
60+
}, [mergedCollapsed]);
61+
5062
const renderItemChildren = (inlineCollapsed: boolean) => {
5163
const label = (children as React.ReactNode[])?.[0];
5264
const wrapNode = (
@@ -73,8 +85,6 @@ const MenuItem: GenericComponent = (props) => {
7385
return wrapNode;
7486
};
7587

76-
const { siderCollapsed } = React.useContext<SiderContextProps>(SiderContext);
77-
7888
let tooltipTitle = title;
7989

8090
if (typeof title === 'undefined') {
@@ -92,11 +102,19 @@ const MenuItem: GenericComponent = (props) => {
92102
title: mergedTooltipTitle,
93103
};
94104

95-
if (!siderCollapsed && !isInlineCollapsed) {
105+
if (!mergedCollapsed) {
96106
tooltipProps.title = null;
97107
// Reset `open` to fix control mode tooltip display not correct
98108
// ref: https://github.com/ant-design/ant-design/issues/16742
99109
tooltipProps.open = false;
110+
} else {
111+
// When collapsed, use controlled state to prevent flash during transitions
112+
// ref: https://github.com/ant-design/ant-design/issues/56528
113+
tooltipProps.open = tooltipConfig?.open ?? tooltipOpen;
114+
tooltipProps.onOpenChange = (open) => {
115+
setTooltipOpen(open);
116+
tooltipConfig?.onOpenChange?.(open);
117+
};
100118
}
101119

102120
const childrenLength = toArray(children).length;

‎components/menu/__tests__/index.test.tsx‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,45 @@ describe('Menu', () => {
605605
expect(container.querySelector('.ant-tooltip-container')).toBeFalsy();
606606
});
607607

608+
// https://github.com/ant-design/ant-design/issues/56528
609+
it('should not flash Tooltip when collapsing while hovered', () => {
610+
const Demo: React.FC = () => {
611+
const [inlineCollapsed, setInlineCollapsed] = useState(false);
612+
return (
613+
<>
614+
<button type="button" onClick={() => setInlineCollapsed(true)}>
615+
collapse
616+
</button>
617+
<Menu
618+
mode="inline"
619+
inlineCollapsed={inlineCollapsed}
620+
getPopupContainer={(node) => node.parentNode as HTMLElement}
621+
>
622+
<Menu.Item key="1" title="Home">
623+
Home
624+
</Menu.Item>
625+
</Menu>
626+
</>
627+
);
628+
};
629+
630+
const { container } = render(<Demo />);
631+
const item = container.querySelector('li.ant-menu-item')!;
632+
633+
fireEvent.mouseEnter(item);
634+
triggerAllTimer();
635+
expect(container.querySelector('.ant-tooltip-container')).toBeFalsy();
636+
637+
fireEvent.click(container.querySelector('button')!);
638+
triggerAllTimer();
639+
640+
// Fresh Tooltip mounts closed; stale hover from expanded state should not open it.
641+
expect(container.querySelector('.ant-tooltip-open')).toBeFalsy();
642+
expect(
643+
container.querySelector('.ant-tooltip:not(.ant-tooltip-hidden) .ant-tooltip-container'),
644+
).toBeFalsy();
645+
});
646+
608647
describe('open submenu when click submenu title', () => {
609648
const toggleMenu = (
610649
instance: ReturnType<typeof render>,

0 commit comments

Comments
 (0)