Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

fix(docs): stabilize docs T menu hover and colors (#7085)

Univer0119ac369019
diff --git a/packages/docs-ui/src/menu/__tests__/schema.spec.ts b/packages/docs-ui/src/menu/__tests__/schema.spec.ts
index f8d3d07b72..19efb4a3ea 100644
--- a/packages/docs-ui/src/menu/__tests__/schema.spec.ts
+++ b/packages/docs-ui/src/menu/__tests__/schema.spec.ts
@@ -20,7 +20,7 @@ import { describe, expect, it } from 'vitest';
import { DocCopyCurrentParagraphCommand, DocCutCurrentParagraphCommand } from '../../commands/commands/clipboard.command';
import { DeleteCurrentParagraphCommand } from '../../commands/commands/doc-delete.command';
import { HorizontalLineCommand, InsertHorizontalLineBellowCommand } from '../../commands/commands/doc-horizontal-line.command';
-import { ResetInlineFormatTextBackgroundColorCommand, SetInlineFormatTextColorCommand } from '../../commands/commands/inline-format.command';
+import { ResetInlineFormatTextBackgroundColorCommand, ResetInlineFormatTextColorCommand, SetInlineFormatTextColorCommand } from '../../commands/commands/inline-format.command';
import { BulletListCommand, CheckListCommand, InsertBulletListBellowCommand, InsertCheckListBellowCommand, InsertOrderListBellowCommand, OrderListCommand } from '../../commands/commands/list.command';
import { AlignCenterCommand, AlignJustifyCommand, AlignLeftCommand, AlignOperationCommand, AlignRightCommand } from '../../commands/commands/paragraph-align.command';
import { H1HeadingCommand, H2HeadingCommand, H3HeadingCommand, H4HeadingCommand, H5HeadingCommand, NormalTextHeadingCommand, SetParagraphNamedStyleCommand, SubtitleHeadingCommand, TitleHeadingCommand } from '../../commands/commands/set-heading.command';
@@ -49,9 +49,9 @@ import {
InsertHorizontalLineBellowMenuItemFactory,
InsertOrderListBellowMenuItemFactory,
ParagraphMenuBackgroundColorHeaderActionMenuItemFactory,
- ParagraphMenuDefaultTextColorMenuItemFactory,
ParagraphMenuInsertBelowHeadingH1MenuItemFactory,
ParagraphMenuInsertBelowTableMenuItemFactory,
+ ParagraphMenuResetTextColorMenuItemFactory,
ParagraphMenuTextColorHeaderActionMenuItemFactory,
} from '../paragraph-menu';
import { menuSchema } from '../schema';
@@ -311,7 +311,9 @@ describe('docs ui ribbon schema', () => {
expect(colorsMenu.text.quickLayout).toBe('icon');
expect(colorsMenu.text.quickColumns).toBe(8);
expect(colorsMenu.text.quickLayoutVariant).toBe('compact');
- expect(colorsMenu.text[`${SetInlineFormatTextColorCommand.id}.default`].menuItemFactory).toBe(ParagraphMenuDefaultTextColorMenuItemFactory);
+ expect(colorsMenu.text[`${SetInlineFormatTextColorCommand.id}.default`]).toBeUndefined();
+ expect(colorsMenu.text[ResetInlineFormatTextColorCommand.id].order).toBe(0);
+ expect(colorsMenu.text[ResetInlineFormatTextColorCommand.id].menuItemFactory).toBe(ParagraphMenuResetTextColorMenuItemFactory);
expect(colorsMenu.backgroundTop.title).toBe('docs-ui.toolbar.fillColor.main');
expect(colorsMenu.backgroundTop.headerActionMenuItemFactory).toBe(ParagraphMenuBackgroundColorHeaderActionMenuItemFactory);
expect(colorsMenu.backgroundTop.quickLayout).toBe('icon');
diff --git a/packages/docs-ui/src/menu/schema.ts b/packages/docs-ui/src/menu/schema.ts
index ec090d4ed0..3ec6ff59c8 100644
--- a/packages/docs-ui/src/menu/schema.ts
+++ b/packages/docs-ui/src/menu/schema.ts
@@ -125,7 +125,6 @@ import {
ParagraphMenuBackgroundColorHeaderActionMenuItemFactory,
ParagraphMenuBackgroundColorSwatchMenuItemFactories,
ParagraphMenuColorsSubmenuItemFactory,
- ParagraphMenuDefaultTextColorMenuItemFactory,
ParagraphMenuIndentDecreaseMenuItemFactory,
ParagraphMenuIndentIncreaseMenuItemFactory,
ParagraphMenuInsertBelowHeadingH1MenuItemFactory,
@@ -818,12 +817,8 @@ export const menuSchema: MenuSchemaType = {
quickLayout: 'icon',
quickColumns: 8,
quickLayoutVariant: 'compact',
- [`${SetInlineFormatTextColorCommand.id}.default`]: {
- order: 0,
- menuItemFactory: ParagraphMenuDefaultTextColorMenuItemFactory,
- },
[ResetInlineFormatTextColorCommand.id]: {
- order: 8,
+ order: 0,
menuItemFactory: ParagraphMenuResetTextColorMenuItemFactory,
},
...ParagraphMenuTextColorSwatchMenuItemFactories,
diff --git a/packages/docs-ui/src/views/ParagraphMenu.tsx b/packages/docs-ui/src/views/ParagraphMenu.tsx
index e26d846db3..cea997af58 100644
--- a/packages/docs-ui/src/views/ParagraphMenu.tsx
+++ b/packages/docs-ui/src/views/ParagraphMenu.tsx
@@ -33,7 +33,7 @@ import { MoveDocBlockCommand } from '../commands/commands/doc-block-move.command
import { DeleteCurrentParagraphCommand } from '../commands/commands/doc-delete.command';
import { HorizontalLineCommand } from '../commands/commands/doc-horizontal-line.command';
import { DocParagraphSettingCommand } from '../commands/commands/doc-paragraph-setting.command';
-import { ResetInlineFormatTextBackgroundColorCommand, SetInlineFormatTextBackgroundColorCommand, SetInlineFormatTextColorCommand } from '../commands/commands/inline-format.command';
+import { ResetInlineFormatTextBackgroundColorCommand, ResetInlineFormatTextColorCommand, SetInlineFormatTextBackgroundColorCommand, SetInlineFormatTextColorCommand } from '../commands/commands/inline-format.command';
import { BulletListCommand, CheckListCommand, OrderListCommand } from '../commands/commands/list.command';
import { AlignCenterCommand, AlignJustifyCommand, AlignLeftCommand, AlignRightCommand } from '../commands/commands/paragraph-align.command';
import { H1HeadingCommand, H2HeadingCommand, H3HeadingCommand, H4HeadingCommand, H5HeadingCommand, NormalTextHeadingCommand, SetParagraphNamedStyleCommand, SubtitleHeadingCommand, TitleHeadingCommand } from '../commands/commands/set-heading.command';
@@ -66,6 +66,19 @@ const PARAGRAPH_MENU_HOVER_BRIDGE_EDGE_OVERLAP = 12;
const PARAGRAPH_MENU_HOVER_BRIDGE_VERTICAL_PADDING = 8;
type ParagraphMenuOpenMode = 'pointer' | 'slash';
+function getParagraphMenuTriggerClassName(visible: boolean) {
+ return clsx(`
+ univer-mr-1 univer-inline-flex univer-h-7 univer-cursor-pointer univer-items-center univer-gap-1 univer-rounded-md
+ univer-border univer-border-gray-200 univer-bg-white univer-px-2 univer-py-0 univer-shadow-sm
+ univer-transition-colors
+ hover:univer-bg-gray-50 hover:univer-shadow-md
+ dark:!univer-border-gray-700 dark:!univer-bg-gray-900
+ dark:hover:!univer-bg-gray-800
+ `, {
+ 'univer-bg-gray-100 univer-shadow-md dark:!univer-bg-gray-800': visible,
+ });
+}
+
export function createParagraphMenuHoverOpenScheduler(openMenu: () => void, delay = PARAGRAPH_MENU_HOVER_OPEN_DELAY) {
let openTimer: number | null = null;
@@ -216,7 +229,9 @@ const PARAGRAPH_MENU_SELECTION_COMMAND_IDS = new Set([
CheckListCommand.id,
HorizontalLineCommand.id,
SetInlineFormatTextColorCommand.id,
+ ResetInlineFormatTextColorCommand.id,
SetInlineFormatTextBackgroundColorCommand.id,
+ ResetInlineFormatTextBackgroundColorCommand.id,
...PARAGRAPH_MENU_BLOCK_RANGE_COMMAND_IDS,
AlignLeftCommand.id,
AlignCenterCommand.id,
@@ -230,6 +245,17 @@ const PARAGRAPH_MENU_SKIP_REPLACE_SELECTION_COMMAND_IDS = new Set([
DeleteCurrentParagraphCommand.id,
]);
+const PARAGRAPH_MENU_RESTORE_SELECTION_COMMAND_IDS = new Set([
+ SetInlineFormatTextColorCommand.id,
+ ResetInlineFormatTextColorCommand.id,
+ SetInlineFormatTextBackgroundColorCommand.id,
+ ResetInlineFormatTextBackgroundColorCommand.id,
+]);
+
+function shouldRestoreParagraphMenuSelectionAfterCommand(commandId: string | undefined) {
+ return !!commandId && PARAGRAPH_MENU_RESTORE_SELECTION_COMMAND_IDS.has(commandId);
+}
+
export function getParagraphMenuCommand(params: IValueOption, targetRange?: ITextRangeWithStyle | null): { commandId?: string; params?: object } {
const commandId = params.commandId ?? params.id ?? (typeof params.label === 'string' ? params.label : undefined);
if (commandId && targetRange && commandId in HEADING_COMMAND_VALUES) {
@@ -733,6 +759,18 @@ function ParagraphMenuBase({ popup, tableBlockOnly = false }: { popup: IPopup; t
docSelectionManagerService.replaceTextRanges([range], false);
};
+ const getCurrentTextRangesSnapshot = () => {
+ return (docSelectionManagerService.getTextRanges() ?? []).map((range) => ({ ...range }));
+ };
+
+ const restoreTextRanges = (ranges: ITextRangeWithStyle[] | null) => {
+ if (!ranges) {
+ return;
+ }
+
+ docSelectionManagerService.replaceTextRanges(ranges, false);
+ };
+
const executeResolvedCommand = (option: IValueOption, targetRange?: ITextRangeWithStyle | null) => {
const resolved = getParagraphMenuResolvedCommand(option, targetRange);
@@ -891,6 +929,10 @@ function ParagraphMenuBase({ popup, tableBlockOnly = false }: { popup: IPopup; t
return;
}
+ const previousTextRanges = shouldRestoreParagraphMenuSelectionAfterCommand(commandId)
+ ? getCurrentTextRangesSnapshot()
+ : null;
+
if (commandId && shouldUseInsertBelowRange(commandId, option) && latestTarget?.moveRange) {
docContentInsertService.setInsertRange({
unitId: popup.unitId,
@@ -902,11 +944,15 @@ function ParagraphMenuBase({ popup, tableBlockOnly = false }: { popup: IPopup; t
replaceSelection(getParagraphMenuCommandTargetRange(commandId, targetRange, formattingRange));
}
- await executeResolvedCommand({
- ...option,
- commandId,
- params: commandParams as Record<string, unknown> | undefined,
- }, getParagraphMenuCommandTargetRange(commandId, targetRange, formattingRange));
+ try {
+ await executeResolvedCommand({
+ ...option,
+ commandId,
+ params: commandParams as Record<string, unknown> | undefined,
+ }, getParagraphMenuCommandTargetRange(commandId, targetRange, formattingRange));
+ } finally {
+ restoreTextRanges(previousTextRanges);
+ }
finishParagraphMenuCommand(docParagraphMenuService, layoutService, handleHideMenu);
};
@@ -945,16 +991,7 @@ function ParagraphMenuBase({ popup, tableBlockOnly = false }: { popup: IPopup; t
<div
data-u-comp="paragraph-menu"
ref={anchorRef}
- className={clsx(`
- univer-mr-1 univer-inline-flex univer-h-8 univer-cursor-pointer univer-items-center univer-gap-1.5
- univer-rounded-lg univer-border univer-border-gray-200 univer-bg-white univer-px-2.5 univer-py-0
- univer-shadow-sm univer-transition-colors
- hover:univer-bg-gray-50 hover:univer-shadow-md
- dark:!univer-border-gray-700 dark:!univer-bg-gray-900
- dark:hover:!univer-bg-gray-800
- `, {
- 'univer-bg-gray-100 univer-shadow-md dark:!univer-bg-gray-800': visible,
- })}
+ className={getParagraphMenuTriggerClassName(visible)}
onMouseEnter={(e) => {
popup.onPointerEnter?.(e);
setParagraphMenuInteractionActive(docParagraphMenuService, true);
@@ -1112,6 +1149,15 @@ function ParagraphMenuBase({ popup, tableBlockOnly = false }: { popup: IPopup; t
autoFocus={openMode === 'slash'}
autoFocusTarget={openMode === 'slash' ? 'container' : undefined}
suppressHoverUntilPointerMove={openMode === 'slash'}
+ onMenuPointerEnter={() => {
+ setParagraphMenuInteractionActive(docParagraphMenuService, true);
+ isMouseOver.current = true;
+ clearHideTimer();
+ }}
+ onMenuPointerLeave={() => {
+ isMouseOver.current = false;
+ scheduleHideMenu();
+ }}
onCancel={() => {
finishParagraphMenuCommand(docParagraphMenuService, layoutService, handleHideMenu);
}}
diff --git a/packages/ui/src/views/components/context-menu/ContextMenuPanel.tsx b/packages/ui/src/views/components/context-menu/ContextMenuPanel.tsx
index 5d4d7c0dc6..e4c2638c96 100644
--- a/packages/ui/src/views/components/context-menu/ContextMenuPanel.tsx
+++ b/packages/ui/src/views/components/context-menu/ContextMenuPanel.tsx
@@ -52,6 +52,8 @@ interface IContextMenuPanelProps {
autoFocusTarget?: ContextMenuAutoFocusTarget;
suppressHoverUntilPointerMove?: boolean;
onCancel?: () => void;
+ onMenuPointerEnter?: () => void;
+ onMenuPointerLeave?: () => void;
onOptionSelect?: (option: IValueOption) => void;
}
@@ -59,11 +61,14 @@ interface IContextMenuMenuProps {
menuSchemas: IMenuSchema[];
menuSessionVersion: number;
submenuPortalContainer: HTMLElement | null;
+ rootMenuElement: HTMLElement | null;
maxMenuHeight: number;
activeItemIds?: string[];
hiddenItemIds?: string[];
hoverSuppressed?: boolean;
sizeVariant: ContextMenuSizeVariant;
+ onMenuPointerEnter?: () => void;
+ onMenuPointerLeave?: () => void;
onOptionSelect?: (option: IValueOption) => void;
}
@@ -72,6 +77,7 @@ interface IContextMenuMenuItemProps {
menuItem: IDisplayMenuItem<IMenuItem>;
menuSessionVersion: number;
submenuPortalContainer: HTMLElement | null;
+ rootMenuElement: HTMLElement | null;
maxMenuHeight: number;
activeSubmenuKey: string | null;
setActiveSubmenuKey: Dispatch<SetStateAction<string | null>>;
@@ -81,6 +87,8 @@ interface IContextMenuMenuItemProps {
compact?: boolean;
headerAction?: boolean;
sizeVariant: ContextMenuSizeVariant;
+ onMenuPointerEnter?: () => void;
+ onMenuPointerLeave?: () => void;
onOptionSelect?: (option: IValueOption) => void;
}
@@ -392,6 +400,22 @@ export function getContextMenuQuickGroupColumns(menuSchema: IMenuSchema): number
return undefined;
}
+function isContextMenuPointerLeaveTarget(
+ nextTarget: Node | null,
+ owningMenuItemElement: HTMLElement | null,
+ rootMenuElement: HTMLElement | null
+) {
+ if (!nextTarget) {
+ return true;
+ }
+
+ if (owningMenuItemElement?.contains(nextTarget) || rootMenuElement?.contains(nextTarget)) {
+ return false;
+ }
+
+ return true;
+}
+
function getContextMenuContentClassName(sizeVariant: ContextMenuSizeVariant) {
return contextMenuContentVariants({ sizeVariant });
}
@@ -628,6 +652,8 @@ export function ContextMenuPanel(props: IContextMenuPanelProps) {
autoFocusTarget = 'first-item',
suppressHoverUntilPointerMove = false,
onCancel,
+ onMenuPointerEnter,
+ onMenuPointerLeave,
onOptionSelect,
} = props;
const menuManagerService = useDependency(IMenuManagerService);
@@ -783,10 +809,13 @@ export function ContextMenuPanel(props: IContextMenuPanelProps) {
menuSchemas={menuItems}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={menuElement}
activeItemIds={activeItemIds}
hiddenItemIds={hiddenItemIds}
hoverSuppressed={hoverSuppressed}
sizeVariant={sizeVariant}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
onOptionSelect={onOptionSelect}
maxMenuHeight={maxMenuHeight}
/>
@@ -795,7 +824,7 @@ export function ContextMenuPanel(props: IContextMenuPanelProps) {
}
function ContextMenuMenu(props: IContextMenuMenuProps) {
- const { menuSchemas, menuSessionVersion, submenuPortalContainer, activeItemIds, hiddenItemIds, hoverSuppressed, sizeVariant, onOptionSelect, maxMenuHeight } = props;
+ const { menuSchemas, menuSessionVersion, submenuPortalContainer, rootMenuElement, activeItemIds, hiddenItemIds, hoverSuppressed, sizeVariant, onMenuPointerEnter, onMenuPointerLeave, onOptionSelect, maxMenuHeight } = props;
const localeService = useDependency(LocaleService);
const hiddenGroupStates = useContextGroupHiddenStates(menuSchemas);
const [activeSubmenuKey, setActiveSubmenuKey] = useState<string | null>(null);
@@ -896,6 +925,7 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
menuItem={menuSchema.item as IDisplayMenuItem<IMenuItem>}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={rootMenuElement}
activeSubmenuKey={activeSubmenuKey}
setActiveSubmenuKey={setActiveSubmenuKey}
onOptionSelect={onOptionSelect}
@@ -903,6 +933,8 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
hiddenItemIds={hiddenItemIds}
hoverSuppressed={hoverSuppressed}
sizeVariant={sizeVariant}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
/>
);
}
@@ -934,11 +966,14 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
menuItem={childSchema.item as IDisplayMenuItem<IMenuItem>}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={rootMenuElement}
activeSubmenuKey={activeSubmenuKey}
setActiveSubmenuKey={setActiveSubmenuKey}
activeItemIds={activeItemIds}
hiddenItemIds={hiddenItemIds}
hoverSuppressed={hoverSuppressed}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
onOptionSelect={onOptionSelect}
maxMenuHeight={maxMenuHeight}
compact
@@ -967,11 +1002,14 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
menuItem={childSchema.item as IDisplayMenuItem<IMenuItem>}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={rootMenuElement}
activeSubmenuKey={activeSubmenuKey}
setActiveSubmenuKey={setActiveSubmenuKey}
activeItemIds={activeItemIds}
hiddenItemIds={hiddenItemIds}
hoverSuppressed={hoverSuppressed}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
onOptionSelect={onOptionSelect}
maxMenuHeight={maxMenuHeight}
sizeVariant={sizeVariant}
@@ -1009,6 +1047,7 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
menuItem={menuSchema.headerActionItem as IDisplayMenuItem<IMenuItem>}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={rootMenuElement}
activeSubmenuKey={activeSubmenuKey}
setActiveSubmenuKey={setActiveSubmenuKey}
activeItemIds={activeItemIds}
@@ -1017,6 +1056,8 @@ function ContextMenuMenu(props: IContextMenuMenuProps) {
compact
headerAction
sizeVariant={sizeVariant}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
onOptionSelect={onOptionSelect}
maxMenuHeight={maxMenuHeight}
/>
@@ -1031,6 +1072,7 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
menuItem,
menuSessionVersion,
submenuPortalContainer,
+ rootMenuElement,
maxMenuHeight,
activeSubmenuKey,
setActiveSubmenuKey,
@@ -1040,6 +1082,8 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
compact = false,
headerAction = false,
sizeVariant,
+ onMenuPointerEnter,
+ onMenuPointerLeave,
onOptionSelect,
} = props;
const localeService = useDependency(LocaleService);
@@ -1217,6 +1261,11 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
if (hasSubmenu && !disabled && !hoverSuppressed) {
setSubmenuPositionReady(false);
setActiveSubmenuKey(menuKey);
+ return;
+ }
+
+ if (!hasSubmenu && !hoverSuppressed) {
+ setActiveSubmenuKey(null);
}
}}
onMouseLeave={(event) => {
@@ -1324,7 +1373,10 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
visibility: submenuPositionReady ? 'visible' : 'hidden',
pointerEvents: submenuPositionReady ? 'auto' : 'none',
}}
- onMouseEnter={clearSubmenuCloseTimer}
+ onMouseEnter={() => {
+ clearSubmenuCloseTimer();
+ onMenuPointerEnter?.();
+ }}
onMouseLeave={(event) => {
const nextTarget = event.relatedTarget as Node | null;
if (nextTarget && menuItemElementRef.current?.contains(nextTarget)) {
@@ -1332,6 +1384,9 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
}
scheduleSubmenuClose();
+ if (isContextMenuPointerLeaveTarget(nextTarget, menuItemElementRef.current, rootMenuElement)) {
+ onMenuPointerLeave?.();
+ }
}}
onWheel={(event) => event.stopPropagation()}
>
@@ -1453,10 +1508,13 @@ function ContextMenuMenuItem(props: IContextMenuMenuItemProps) {
menuSchemas={subMenuItems}
menuSessionVersion={menuSessionVersion}
submenuPortalContainer={submenuPortalContainer}
+ rootMenuElement={rootMenuElement}
activeItemIds={activeItemIds}
hiddenItemIds={hiddenItemIds}
hoverSuppressed={hoverSuppressed}
sizeVariant={sizeVariant}
+ onMenuPointerEnter={onMenuPointerEnter}
+ onMenuPointerLeave={onMenuPointerLeave}
onOptionSelect={onSubmenuOptionSelect}
maxMenuHeight={maxMenuHeight}
/>
diff --git a/packages/ui/src/views/components/context-menu/__tests__/ContextMenuPanel.spec.tsx b/packages/ui/src/views/components/context-menu/__tests__/ContextMenuPanel.spec.tsx
index ff5fd71293..d0f6c96ab2 100644
--- a/packages/ui/src/views/components/context-menu/__tests__/ContextMenuPanel.spec.tsx
+++ b/packages/ui/src/views/components/context-menu/__tests__/ContextMenuPanel.spec.tsx
@@ -14,11 +14,11 @@
* limitations under the License.
*/
-import { act, fireEvent, render, screen } from '@testing-library/react';
+import { act, cleanup, fireEvent, render, screen } from '@testing-library/react';
import { LocaleService } from '@univerjs/core';
import React from 'react';
import { BehaviorSubject } from 'rxjs';
-import { describe, expect, it, vi } from 'vitest';
+import { afterEach, describe, expect, it, vi } from 'vitest';
import { ILayoutService } from '../../../../services/layout/layout.service';
import { MenuItemType } from '../../../../services/menu/menu';
import { IMenuManagerService } from '../../../../services/menu/menu-manager.service';
@@ -35,6 +35,11 @@ import {
const dependencyMap = new Map();
const tinyMenuGroupSpy = vi.fn();
+afterEach(() => {
+ cleanup();
+ vi.useRealTimers();
+});
+
vi.mock('../../../../utils/di', async () => {
const ReactModule = await import('react');
@@ -754,4 +759,163 @@ describe('ContextMenuPanel', () => {
vi.useRealTimers();
});
+
+ it('closes an open submenu immediately when hovering a plain root menu item', () => {
+ vi.useFakeTimers();
+ dependencyMap.clear();
+
+ dependencyMap.set(IMenuManagerService, {
+ menuChanged$: new BehaviorSubject<void>(undefined),
+ getMenuByPositionKey: vi.fn((key: string) => {
+ if (key === 'submenu-root') {
+ return [
+ {
+ key: 'insert',
+ order: 0,
+ item: {
+ id: 'insert',
+ type: MenuItemType.SUBITEMS,
+ title: 'insert',
+ tooltip: 'insert',
+ },
+ },
+ {
+ key: 'align',
+ order: 1,
+ item: {
+ id: 'align',
+ type: MenuItemType.BUTTON,
+ title: 'align',
+ tooltip: 'align',
+ },
+ },
+ ];
+ }
+
+ if (key === 'insert') {
+ return [{
+ key: 'insert-option',
+ order: 0,
+ item: {
+ id: 'insert-option',
+ type: MenuItemType.BUTTON,
+ title: 'insert option',
+ tooltip: 'insert option',
+ },
+ }];
+ }
+
+ return [];
+ }),
+ });
+ dependencyMap.set(ILayoutService, {
+ rootContainerElement: document.body,
+ });
+ dependencyMap.set(LocaleService, {
+ t: (key: string) => key,
+ direction$: new BehaviorSubject<'ltr'>('ltr'),
+ });
+
+ render(<ContextMenuPanel menuType="submenu-root" />);
+
+ const insertButton = document.querySelector('button[title="insert"]') as HTMLButtonElement | null;
+ const alignButton = document.querySelector('button[title="align"]') as HTMLButtonElement | null;
+ expect(insertButton).not.toBeNull();
+ expect(alignButton).not.toBeNull();
+
+ act(() => {
+ fireEvent.mouseEnter(insertButton!.parentElement!);
+ });
+ expect(document.querySelector('button[title="insert option"]')).not.toBeNull();
+
+ act(() => {
+ fireEvent.mouseLeave(insertButton!.parentElement!, { relatedTarget: alignButton });
+ fireEvent.mouseEnter(alignButton!.parentElement!);
+ });
+
+ expect(document.querySelector('button[title="insert option"]')).toBeNull();
+
+ vi.useRealTimers();
+ });
+
+ it('does not report a menu pointer leave when moving from a portal submenu back to the root menu', () => {
+ dependencyMap.clear();
+ const onMenuPointerLeave = vi.fn();
+
+ dependencyMap.set(IMenuManagerService, {
+ menuChanged$: new BehaviorSubject<void>(undefined),
+ getMenuByPositionKey: vi.fn((key: string) => {
+ if (key === 'submenu-root') {
+ return [
+ {
+ key: 'insert',
+ order: 0,
+ item: {
+ id: 'insert',
+ type: MenuItemType.SUBITEMS,
+ title: 'insert',
+ tooltip: 'insert',
+ },
+ },
+ {
+ key: 'align',
+ order: 1,
+ item: {
+ id: 'align',
+ type: MenuItemType.BUTTON,
+ title: 'align',
+ tooltip: 'align',
+ },
+ },
+ ];
+ }
+
+ if (key === 'insert') {
+ return [{
+ key: 'insert-option',
+ order: 0,
+ item: {
+ id: 'insert-option',
+ type: MenuItemType.BUTTON,
+ title: 'insert option',
+ tooltip: 'insert option',
+ },
+ }];
+ }
+
+ return [];
+ }),
+ });
+ dependencyMap.set(ILayoutService, {
+ rootContainerElement: document.body,
+ });
+ dependencyMap.set(LocaleService, {
+ t: (key: string) => key,
+ direction$: new BehaviorSubject<'ltr'>('ltr'),
+ });
+
+ render(
+ <ContextMenuPanel
+ menuType="submenu-root"
+ onMenuPointerLeave={onMenuPointerLeave}
+ />
+ );
+
+ const insertButton = document.querySelector('button[title="insert"]') as HTMLButtonElement | null;
+ const alignButton = document.querySelector('button[title="align"]') as HTMLButtonElement | null;
+ expect(insertButton).not.toBeNull();
+ expect(alignButton).not.toBeNull();
+
+ act(() => {
+ fireEvent.mouseEnter(insertButton!.parentElement!);
+ });
+
+ const optionButton = Array.from(document.querySelectorAll<HTMLButtonElement>('button[title="insert option"]')).pop() ?? null;
+ const submenu = optionButton?.closest(`[${CONTEXT_MENU_SUBMENU_PORTAL_ATTR}="true"]`) as HTMLDivElement | null;
+ expect(submenu).not.toBeNull();
+
+ fireEvent.mouseLeave(submenu!, { relatedTarget: alignButton });
+
+ expect(onMenuPointerLeave).not.toHaveBeenCalled();
+ });
});