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.
TypeScript boardcollaborationdocdocxexceloffce365officepdfpptpptxpresentationsdksheetslidesspreadsheetuniverwordwordprocessorworkspacexlsx
fix(sheets-table-ui): keep table controls below floating images (#8100)
白熱7cb08fac3eb7
diff --git a/packages/sheets-table-ui/src/controllers/__tests__/sheet-table-controls-render.controller.spec.ts b/packages/sheets-table-ui/src/controllers/__tests__/sheet-table-controls-render.controller.spec.tsindex ddbb6c0457..4bf985ee76 100644--- a/packages/sheets-table-ui/src/controllers/__tests__/sheet-table-controls-render.controller.spec.ts+++ b/packages/sheets-table-ui/src/controllers/__tests__/sheet-table-controls-render.controller.spec.ts@@ -14,188 +14,235 @@* limitations under the License.*/-import { CommandType, ContextService } from '@univerjs/core';-import { SelectRangeCommand } from '@univerjs/sheets';-import { DeleteSheetTableCommand } from '@univerjs/sheets-table';-import { MoveSelectionCommand, SelectAllCommand } from '@univerjs/sheets-ui';-import { Subject } from 'rxjs';-import { describe, expect, it, vi } from 'vitest';+import type { IWorkbookData, Workbook } from '@univerjs/core';+import type { IRenderContext } from '@univerjs/engine-render';+import {+ CommandType,+ ICommandService,+ LocaleService,+ LocaleType,+ Univer,+ UniverInstanceType,+} from '@univerjs/core';+import {+ CanvasColorService,+ DRAWING_OBJECT_LAYER_INDEX,+ Engine,+ ICanvasColorService,+ Image,+ Rect,+ Scene,+ SHEET_VIEWPORT_KEY,+ Vector2,+ Viewport,+} from '@univerjs/engine-render';+import {+ RangeProtectionRuleModel,+ SelectRangeCommand,+ SheetInterceptorService,+ SheetRangeThemeModel,+ SheetSkeletonService,+ SheetsSelectionsService,+ WorkbookPermissionService,+ WorksheetProtectionPointModel,+ WorksheetProtectionRuleModel,+} from '@univerjs/sheets';+import { DeleteSheetTableCommand, DeleteSheetTableMutation, SheetTableService, TableManager } from '@univerjs/sheets-table';+import {+ ISheetSelectionRenderService,+ MoveSelectionCommand,+ SelectAllCommand,+ SheetCanvasPopManagerService,+ SheetSkeletonManagerService,+} from '@univerjs/sheets-ui';+import {+ DesktopDialogService,+ DesktopSidebarService,+ IDialogService,+ ISidebarService,+ IUIPartsService,+ UIPartsService,+} from '@univerjs/ui';+import { afterEach, describe, expect, it, vi } from 'vitest';+import type { ISheetTableMenuExtraProps } from '../../views/components/SheetTableMenu';+import type { SheetTableControlsShape } from '../../views/widgets/table-controls.shape';import { SHEET_TABLE_MENU } from '../../const';+import enUS from '../../locale/en-US';+import { SheetTableControlsMobileRenderController } from '../mobile/sheet-table-controls-render.controller';import { SheetTableControlsRenderController } from '../sheet-table-controls-render.controller';+import { SheetTableThemeUIController } from '../sheet-table-theme-ui.controller';-interface ITestTable {- getId: () => string;- getDisplayName: () => string;- getRange: () => { startRow: number; endRow: number; startColumn: number; endColumn: number };- getTableStyleId: () => string;-}+const disposables: Array<{ dispose: () => void }> = [];-function createController(hasSkeleton = true, tables: ITestTable[] = []) {- const activeSheet$ = new Subject();- const currentSkeleton$ = new Subject();- const tableAdd$ = new Subject();- const selectionChanged$ = new Subject();- const sceneMakeDirty = vi.fn();- const executeTableCommand = vi.fn();- const popupDisposable = { dispose: vi.fn() };- const attachPopupByPosition = vi.fn((_bound: unknown, _popup: unknown, _location: unknown) => popupDisposable);- const skeleton = hasSkeleton ? { gapConfig: { rowGaps: {} } } : null;- let commandListener: ((command: { id: string; type: CommandType }) => void) | undefined;-- const controller = new SheetTableControlsRenderController(- {- unit: {- activeSheet$,- getActiveSheet: () => ({ getSheetId: () => 'sheet-1' }),- getUnitId: () => 'unit-1',- },- scene: {- addObjects: vi.fn(),- removeObjects: vi.fn(),- makeDirty: sceneMakeDirty,- setCursor: vi.fn(),- resetCursor: vi.fn(),- },- components: { get: vi.fn() },- } as never,- {} as never,- {- currentSkeleton$,- getCurrentSkeleton: () => skeleton,- } as never,- {- onCommandExecuted: (listener: (command: { id: string; type: CommandType }) => void) => {- commandListener = listener;- return { dispose: vi.fn() };- },- executeCommand: executeTableCommand,- } as never,- {- tableAdd$,- tableDelete$: new Subject(),- tableNameChanged$: new Subject(),- tableRangeChanged$: new Subject(),- tableThemeChanged$: new Subject(),- getTablesBySubunitId: () => tables,- getTableById: (_unitId: string, tableId: string) => tables.find((table) => table.getId() === tableId),- } as never,- { getRangeThemeStyle: vi.fn() } as never,- { unitPermissionInitStateChange$: new Subject() } as never,- {- permissionPointUpdate$: new Subject(),- getPermissionPoint: () => ({ value: true }),- } as never,- {- selectionChanged$,- getCurrentSelections: () => [],- } as never,- { resetSelectionsByModelData: vi.fn() } as never,- { refreshTable$: new Subject() } as never,- { t: (key: string) => key } as never,- new ContextService(),- {} as never,- {} as never,- { attachPopupByPosition } as never- );+afterEach(() => {+ disposables.reverse().forEach((disposable) => disposable.dispose());+ disposables.length = 0;+ vi.restoreAllMocks();+});- sceneMakeDirty.mockClear();- return {- controller,- sceneMakeDirty,- selectionChanged$,- tableAdd$,- attachPopupByPosition,- executeTableCommand,- popupDisposable,- executeCommand: (command: { id: string; type: CommandType }) => commandListener?.(command),- };+function createTestBed(hasSkeleton = true, controllerType = SheetTableControlsRenderController) {+ // happy-dom has no native canvas; scene ordering and hit testing stay real.+ const context2d = new Proxy({+ canvas: document.createElement('canvas'),+ getTransform: () => ({ a: 1, b: 0, c: 0, d: 1, e: 0, f: 0 }),+ }, {+ get: (target, key) => Reflect.get(target, key) ?? (() => {}),+ });+ vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockReturnValue(context2d as never);+ const univer = new Univer();+ disposables.push(univer);+ const injector = univer.__getInjector();+ const locale = injector.get(LocaleService);+ locale.load({ enUS });+ locale.setLocale(LocaleType.EN_US);+ locale.setDirection('ltr');+ injector.add([ICanvasColorService, { useClass: CanvasColorService }]);+ injector.add([SheetInterceptorService]);+ injector.add([SheetRangeThemeModel]);+ injector.add([SheetSkeletonService]);+ injector.add([SheetsSelectionsService]);+ injector.add([RangeProtectionRuleModel]);+ injector.add([WorksheetProtectionRuleModel]);+ injector.add([WorksheetProtectionPointModel]);+ injector.add([WorkbookPermissionService]);+ injector.add([TableManager]);+ injector.add([SheetTableService]);+ injector.add([SheetTableThemeUIController]);+ const popupDisposable = { dispose: vi.fn(), canDispose: () => true };+ const attachPopupByPosition = vi.fn((_bound: unknown, _popup: unknown, _location: unknown) => popupDisposable);+ injector.add([SheetCanvasPopManagerService, { useValue: { attachPopupByPosition } as unknown as SheetCanvasPopManagerService }]);+ injector.add([ISheetSelectionRenderService, { useValue: { resetSelectionsByModelData: vi.fn() } as unknown as ISheetSelectionRenderService }]);+ injector.add([IUIPartsService, { useClass: UIPartsService }]);+ injector.add([IDialogService, { useClass: DesktopDialogService }]);+ injector.add([ISidebarService, { useClass: DesktopSidebarService }]);+ const unit = univer.createUnit<IWorkbookData, Workbook>(UniverInstanceType.UNIVER_SHEET, {+ id: 'unit-1',+ sheetOrder: ['sheet-1'],+ sheets: { 'sheet-1': { id: 'sheet-1', rowCount: 20, columnCount: 10 } },+ });+ const engine = injector.createInstance(Engine, 'unit-1', { elementWidth: 800, elementHeight: 600 });+ disposables.push(engine);+ const scene = new Scene('test', engine, { width: 800, height: 600 });+ const viewport = new Viewport(SHEET_VIEWPORT_KEY.VIEW_MAIN, scene, { left: 0, top: 0, right: 0, bottom: 0 });+ disposables.push(viewport);+ const context = { unit, unitId: unit.getUnitId(), engine, scene, components: new Map() } as IRenderContext<Workbook>;+ injector.add([SheetSkeletonManagerService, {+ useFactory: function createSkeletonManager() {+ return injector.createInstance(SheetSkeletonManagerService, context);+ },+ }]);+ injector.add([SheetTableControlsRenderController, {+ useFactory: function createController() {+ return injector.createInstance(controllerType, context);+ },+ }]);+ if (hasSkeleton) {+ injector.get(SheetSkeletonManagerService).setCurrent({ sheetId: 'sheet-1' });+ }+ const tables = injector.get(TableManager);+ const addTable = () => tables.addTable('unit-1', 'sheet-1', 'Orders', {+ startRow: 2,+ endRow: 4,+ startColumn: 2,+ endColumn: 4,+ }, ['Name', 'Amount', 'Tax'], 'table-1');+ return { injector, scene, engine, addTable, attachPopupByPosition, popupDisposable };}describe('SheetTableControlsRenderController', () => {it('keeps sheet caches for selection refreshes and invalidates them for table refreshes', () => {- const { controller, sceneMakeDirty, selectionChanged$, tableAdd$, executeCommand } = createController();-- selectionChanged$.next({});- executeCommand({ id: MoveSelectionCommand.id, type: CommandType.COMMAND });- executeCommand({ id: SelectAllCommand.id, type: CommandType.COMMAND });- executeCommand({ id: SelectRangeCommand.id, type: CommandType.COMMAND });- executeCommand({ id: 'doc.mutation.rich-text-editing', type: CommandType.MUTATION });+ const { injector, scene, addTable } = createTestBed();+ injector.get(SheetTableControlsRenderController);+ const sceneMakeDirty = vi.spyOn(scene, 'makeDirty');+ const commands = injector.get(ICommandService);+ injector.get(SheetsSelectionsService).setSelections('unit-1', 'sheet-1', []);+ for (const id of [MoveSelectionCommand.id, SelectAllCommand.id, SelectRangeCommand.id]) {+ commands.registerCommand({ id, type: CommandType.COMMAND, handler: () => true });+ commands.syncExecuteCommand(id);+ }+ commands.registerCommand({ id: 'doc.mutation.rich-text-editing', type: CommandType.MUTATION, handler: () => true });+ commands.syncExecuteCommand('doc.mutation.rich-text-editing');expect(sceneMakeDirty).not.toHaveBeenCalled();- tableAdd$.next({});+ addTable();expect(sceneMakeDirty).toHaveBeenCalledOnce();-- controller.dispose();});- it('clears unavailable controls without invalidating sheet caches on selection changes', () => {- const { controller, sceneMakeDirty, selectionChanged$ } = createController(false);- const shape = Reflect.get(controller, '_shape') as {- setItems: (items: unknown[]) => void;- refreshBounds: () => void;- };- const setItems = vi.spyOn(shape, 'setItems');- const refreshBounds = vi.spyOn(shape, 'refreshBounds');+ it('hides unavailable controls without invalidating sheet caches on selection changes', () => {+ const { injector, scene } = createTestBed(false);+ injector.get(SheetTableControlsRenderController);+ const sceneMakeDirty = vi.spyOn(scene, 'makeDirty');- selectionChanged$.next({});+ injector.get(SheetsSelectionsService).setSelections('unit-1', 'sheet-1', []);- expect(setItems).toHaveBeenCalledWith([]);- expect(refreshBounds).toHaveBeenCalledOnce();+ expect(scene.getAllObjectsByOrder()).toEqual([]);expect(sceneMakeDirty).not.toHaveBeenCalled();-- controller.dispose();});- it('opens the registered design menu and routes its actions through the existing table commands', async () => {- const table: ITestTable = {- getId: () => 'table-1',- getDisplayName: () => 'Orders',- getRange: () => ({ startRow: 1, endRow: 3, startColumn: 2, endColumn: 4 }),- getTableStyleId: () => 'theme-1',- };- const { attachPopupByPosition, controller, executeTableCommand, popupDisposable } = createController(true, [table]);- const shape = Reflect.get(controller, '_shape') as {- getAnchorRegion: (tableId: string) => unknown;- };- vi.spyOn(shape, 'getAnchorRegion').mockReturnValue({- type: 'anchor-main',- tableId: 'table-1',- left: 40,- top: 20,- width: 122,- height: 28,- });- const handleHit = Reflect.get(controller, '_handleHit') as (hit: object) => void;-- handleHit.call(controller, { type: 'anchor-menu-toggle', tableId: 'table-1' });+ it('opens the table menu and routes deletion through the command service', async () => {+ const { injector, scene, engine, addTable, attachPopupByPosition, popupDisposable } = createTestBed();+ addTable();+ injector.get(SheetTableControlsRenderController);+ const shape = scene.getObject('SheetTableControlsShape') as SheetTableControlsShape;+ shape.render(engine.getCanvas().getContext());+ const anchor = shape.getAnchorRegion('table-1')!;+ shape.onPointerDown$.emitEvent({+ offsetX: anchor.left + anchor.width - 10,+ offsetY: anchor.top + 10,+ stopPropagation: () => {},+ preventDefault: () => {},+ } as never);expect(attachPopupByPosition).toHaveBeenCalledWith(- { left: 40, right: 162, top: 20, bottom: 48 },+ { left: anchor.left, right: anchor.left + anchor.width, top: anchor.top, bottom: anchor.top + anchor.height },expect.objectContaining({ componentKey: SHEET_TABLE_MENU }),- { unitId: 'unit-1', subUnitId: 'sheet-1', row: 1, col: 2 }+ { unitId: 'unit-1', subUnitId: 'sheet-1', row: 2, col: 2 });- const popup = attachPopupByPosition.mock.calls[0][1] as {- extraProps: {- labels: Record<string, string>;- onSelect: (action: 'delete') => void | Promise<void>;- };- };- expect(popup.extraProps.labels).toEqual({- rename: 'sheets-table-ui.rename',- 'update-range': 'sheets-table-ui.updateRange',- 'set-theme': 'sheets-table-ui.setTheme',- settings: 'sheets-table-ui.settings',- delete: 'sheets-table-ui.removeTable',- });+ const popup = attachPopupByPosition.mock.calls[0][1] as { extraProps: ISheetTableMenuExtraProps };+ const commands = injector.get(ICommandService);+ commands.registerCommand(DeleteSheetTableCommand);+ commands.registerCommand(DeleteSheetTableMutation);+ const executeCommand = vi.spyOn(commands, 'executeCommand');await popup.extraProps.onSelect('delete');+ await executeCommand.mock.results[0].value;+ expect(injector.get(TableManager).getTableById('unit-1', 'table-1')).toBeUndefined();expect(popupDisposable.dispose).toHaveBeenCalledOnce();- expect(executeTableCommand).toHaveBeenCalledWith(DeleteSheetTableCommand.id, {+ expect(executeCommand).toHaveBeenCalledWith(DeleteSheetTableCommand.id, {tableId: 'table-1',subUnitId: 'sheet-1',unitId: 'unit-1',});- controller.dispose();});++ it.each([SheetTableControlsRenderController, SheetTableControlsMobileRenderController])(+ 'renders and picks floating images above exposed table controls with %s',+ (controllerType) => {+ const { injector, scene, engine, addTable } = createTestBed(true, controllerType);+ addTable();+ injector.get(SheetTableControlsRenderController);+ const shape = scene.getObject('SheetTableControlsShape') as SheetTableControlsShape;+ shape.render(engine.getCanvas().getContext());+ const anchor = shape.getAnchorRegion('table-1')!;+ const selection = new Rect('selection', { left: 0, top: 0, width: 800, height: 600 });+ scene.addObject(selection, 1);+ const image = new Image('floating-image', {+ left: anchor.left + anchor.width / 2,+ top: anchor.top,+ width: 200,+ height: 150,+ });+ scene.addObject(image, DRAWING_OBJECT_LAYER_INDEX);++ const order = scene.getAllObjectsByOrder();+ expect(order.indexOf(selection)).toBeLessThan(order.indexOf(shape));+ expect(scene.pick(new Vector2(anchor.left + anchor.width - 10, anchor.top + 10))).toBe(image);+ expect(order.indexOf(shape)).toBeLessThan(order.indexOf(image));+ expect(scene.pick(new Vector2(anchor.left + 10, anchor.top + 10))).toBe(shape);++ image.hide();+ expect(scene.pick(new Vector2(anchor.left + anchor.width - 10, anchor.top + 10))).toBe(shape);+ }+ );});diff --git a/packages/sheets-table-ui/src/controllers/sheet-table-controls-render.controller.ts b/packages/sheets-table-ui/src/controllers/sheet-table-controls-render.controller.tsindex f44057e3cc..436e2f0412 100644--- a/packages/sheets-table-ui/src/controllers/sheet-table-controls-render.controller.ts+++ b/packages/sheets-table-ui/src/controllers/sheet-table-controls-render.controller.ts@@ -22,9 +22,6 @@ import type {IRenderModule,SpreadsheetSkeleton,} from '@univerjs/engine-render';-import type { LocaleKey } from '../locale/types';-import type { SheetTableMenuAction } from '../views/components/SheetTableMenu';-import type { ITableControlHitRegion } from '../views/widgets/table-controls-util';import {CommandType,Disposable,@@ -37,7 +34,7 @@ import {LocaleService,toDisposable,} from '@univerjs/core';-import { CURSOR_TYPE, Vector2 } from '@univerjs/engine-render';+import { CURSOR_TYPE, DRAWING_OBJECT_LOWER_LAYER_INDEX, Vector2 } from '@univerjs/engine-render';import {SelectRangeCommand,SheetRangeThemeModel,@@ -66,6 +63,9 @@ import {} from '@univerjs/sheets-ui';import { IDialogService, ISidebarService } from '@univerjs/ui';import { filter, merge } from 'rxjs';+import type { LocaleKey } from '../locale/types';+import type { SheetTableMenuAction } from '../views/components/SheetTableMenu';+import type { ITableControlHitRegion } from '../views/widgets/table-controls-util';import { openRangeSelector } from '../commands/operations/open-table-selector.operation';import {SHEET_TABLE_MENU,@@ -80,7 +80,6 @@ import { TABLE_CONTROL_INSERT_BUTTON_SIZE, TABLE_CONTROL_TOP_GAP_SIZE } from '..import { SheetTableControlsShape } from '../views/widgets/table-controls.shape';import { SheetTableThemeUIController } from './sheet-table-theme-ui.controller';-const TABLE_CONTROLS_LAYER_INDEX = 5002;const TABLE_CONTROL_GAP_ROW = 0;const TABLE_RENDER_REFRESH_COMMANDS = new Set([SetScrollOperation.id,@@ -139,7 +138,7 @@ export class SheetTableControlsRenderController extends Disposable implements IR}private _initShape(): void {- this._context.scene.addObjects([this._shape], TABLE_CONTROLS_LAYER_INDEX);+ this._context.scene.addObjects([this._shape], DRAWING_OBJECT_LOWER_LAYER_INDEX);this.disposeWithMe(toDisposable(() => {this._closeFloatingControls();this._settingsDialog?.dispose();