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(sheets): restore tab-switch focus and ignore inactive formula selections (#7890)

wpxp1234561723e66f6188
diff --git a/packages/sheets-formula-ui/src/views/formula-editor/hooks/__tests__/use-formula-selection.spec.ts b/packages/sheets-formula-ui/src/views/formula-editor/hooks/__tests__/use-formula-selection.spec.ts
index de65e01ca7..6439d121c6 100644
--- a/packages/sheets-formula-ui/src/views/formula-editor/hooks/__tests__/use-formula-selection.spec.ts
+++ b/packages/sheets-formula-ui/src/views/formula-editor/hooks/__tests__/use-formula-selection.spec.ts
@@ -16,7 +16,19 @@
// @vitest-environment jsdom
-import { describe, expect, it, vi } from 'vitest';
+import type { DocumentDataModel, IDocumentData, IWorkbookData, Workbook } from '@univerjs/core';
+import { DOCS_NORMAL_EDITOR_UNIT_ID_KEY, ICommandService, Univer, UniverInstanceType } from '@univerjs/core';
+import { DocSelectionManagerService, SetTextSelectionsOperation } from '@univerjs/docs';
+import { LexerTreeBuilder } from '@univerjs/engine-formula';
+import {
+ IRenderManagerService,
+ NORMAL_TEXT_SELECTION_PLUGIN_STYLE,
+ RenderManagerService,
+} from '@univerjs/engine-render';
+import { RediContext } from '@univerjs/ui';
+import { act, createElement } from 'react';
+import { createRoot } from 'react-dom/client';
+import { describe, expect, it, onTestFinished, vi } from 'vitest';
import {
FormulaSelectingType,
resolveFormulaSelectingIntent,
@@ -25,9 +37,73 @@ import {
resolveFormulaSelectionWorkbook,
shouldAddFormulaReference,
shouldSkipReferenceEditingByPointer,
+ useFormulaSelecting,
} from '../use-formula-selection';
+(globalThis as { IS_REACT_ACT_ENVIRONMENT?: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
+
+function FormulaSelectionState({ isFocus }: { isFocus: boolean }) {
+ const { isSelecting } = useFormulaSelecting({
+ editorId: DOCS_NORMAL_EDITOR_UNIT_ID_KEY,
+ unitId: 'formula-selection-sheet',
+ subUnitId: 'sheet1',
+ isFocus,
+ });
+ return createElement('output', null, isSelecting);
+}
+
describe('use-formula-selection regression scenarios', () => {
+ it.each(['=', '=SUM('])('does not restart reference picking from hidden editor text %s after editing ends', async (input) => {
+ const univer = new Univer();
+ const injector = univer.__getInjector();
+ injector.add([IRenderManagerService, { useClass: RenderManagerService }]);
+ injector.add([DocSelectionManagerService]);
+ injector.add([LexerTreeBuilder]);
+ injector.get(ICommandService).registerCommand(SetTextSelectionsOperation);
+ univer.createUnit<IWorkbookData, Workbook>(UniverInstanceType.UNIVER_SHEET, {
+ id: 'formula-selection-sheet',
+ sheetOrder: ['sheet1'],
+ sheets: { sheet1: { id: 'sheet1' } },
+ });
+ univer.createUnit<IDocumentData, DocumentDataModel>(UniverInstanceType.UNIVER_DOC, {
+ id: DOCS_NORMAL_EDITOR_UNIT_ID_KEY,
+ body: { dataStream: `${input}\r\n` },
+ });
+ const selections = injector.get(DocSelectionManagerService);
+ const container = document.createElement('div');
+ document.body.appendChild(container);
+ const root = createRoot(container);
+ onTestFinished(() => {
+ act(() => root.unmount());
+ container.remove();
+ univer.dispose();
+ });
+ const render = async (isFocus: boolean) => {
+ await act(async () => root.render(createElement(
+ RediContext.Provider,
+ { value: { injector } },
+ createElement(FormulaSelectionState, { isFocus })
+ )));
+ };
+
+ await render(true);
+ expect(container.textContent).toBe(String(FormulaSelectingType.NEED_ADD));
+ await render(false);
+ expect(container.textContent).toBe(String(FormulaSelectingType.NOT_SELECT));
+
+ await act(async () => {
+ selections.__replaceTextRangesWithNoRefresh({
+ textRanges: [{ startOffset: 0, endOffset: 0, collapsed: true, isActive: true }],
+ rectRanges: [],
+ segmentId: '',
+ segmentPage: -1,
+ isEditing: false,
+ style: NORMAL_TEXT_SELECTION_PLUGIN_STYLE,
+ }, { unitId: DOCS_NORMAL_EDITOR_UNIT_ID_KEY, subUnitId: DOCS_NORMAL_EDITOR_UNIT_ID_KEY });
+ });
+ expect(container.textContent).toBe(String(FormulaSelectingType.NOT_SELECT));
+ });
+
it('only skips reference editing when pointer-origin editing is still disabled and click editing is allowed', () => {
expect(shouldSkipReferenceEditingByPointer(true)).toBe(true);
expect(shouldSkipReferenceEditingByPointer(true, true)).toBe(false);
diff --git a/packages/sheets-formula-ui/src/views/formula-editor/hooks/use-formula-selection.ts b/packages/sheets-formula-ui/src/views/formula-editor/hooks/use-formula-selection.ts
index 6397080bd4..e56268bab9 100644
--- a/packages/sheets-formula-ui/src/views/formula-editor/hooks/use-formula-selection.ts
+++ b/packages/sheets-formula-ui/src/views/formula-editor/hooks/use-formula-selection.ts
@@ -161,6 +161,11 @@ export function useFormulaSelecting(opts: { editor?: Editor; editorId: string; i
// eslint-disable-next-line complexity
const calculateSelectingType = useEvent(() => {
+ // Hidden editors still receive selection events before their previous input is replaced.
+ if (!isFocus) {
+ return;
+ }
+
const currentWorkbook = resolveFormulaSelectionWorkbook(
univerInstanceService.getCurrentUnitOfType<Workbook>(UniverInstanceType.UNIVER_SHEET),
workbook
diff --git a/packages/sheets-ui/src/views/sheet-bar/sheet-bar-tabs/SheetBarTabs.tsx b/packages/sheets-ui/src/views/sheet-bar/sheet-bar-tabs/SheetBarTabs.tsx
index a79212eb7f..9d44d70683 100644
--- a/packages/sheets-ui/src/views/sheet-bar/sheet-bar-tabs/SheetBarTabs.tsx
+++ b/packages/sheets-ui/src/views/sheet-bar/sheet-bar-tabs/SheetBarTabs.tsx
@@ -54,7 +54,7 @@ import {
WorkbookRenameSheetPermission,
WorksheetProtectionRuleModel,
} from '@univerjs/sheets';
-import { UI_PLUGIN_CONFIG_KEY, useConfigValue, useDependency, useObservable } from '@univerjs/ui';
+import { ILayoutService, UI_PLUGIN_CONFIG_KEY, useConfigValue, useDependency, useObservable } from '@univerjs/ui';
import { useCallback, useEffect, useRef, useState } from 'react';
import { merge } from 'rxjs';
import { getEmbedSheetsTabCustomData } from '../../../embed-tab-anchor';
@@ -148,6 +148,7 @@ export function SheetBarTabs() {
const activeSheetIdRef = useRef(activeSheetId);
const commandService = useDependency(ICommandService);
+ const layoutService = useDependency(ILayoutService);
const renderManagerService = useDependency(IRenderManagerService);
const sheetBarService = useDependency(ISheetBarService);
const localeService = useDependency(LocaleService);
@@ -370,6 +371,7 @@ export function SheetBarTabs() {
subUnitId,
unitId: workbookRef.current.getUnitId(),
}).then((result) => {
+ requestAnimationFrame(() => layoutService.focus(workbookRef.current.getUnitId()));
if (result !== false) {
return;
}
@@ -380,7 +382,7 @@ export function SheetBarTabs() {
syncActiveSheetRender(subUnitId);
}
});
- }, [commandService, syncActiveSheetRender]);
+ }, [commandService, layoutService, syncActiveSheetRender]);
const observeResize = useCallback((slideTabBar: SlideTabBar) => {
const slideTabBarContainer = slideTabBarContainerRef.current?.querySelector('[data-u-comp=slide-tab-bar]');