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-ui): keep IME input on the selected cell before editing (#7749)

HEOJUNFO5833b347c876
diff --git a/packages/sheets-ui/src/controllers/editor/__tests__/editing.render-controller.spec.ts b/packages/sheets-ui/src/controllers/editor/__tests__/editing.render-controller.spec.ts
index 12b3166d4e..f690988071 100644
--- a/packages/sheets-ui/src/controllers/editor/__tests__/editing.render-controller.spec.ts
+++ b/packages/sheets-ui/src/controllers/editor/__tests__/editing.render-controller.spec.ts
@@ -943,4 +943,40 @@ describe('EditingRenderController business methods', () => {
expect(cellEditorSelectionSync).toHaveBeenCalledTimes(1);
expect(hostSelectionSync).not.toHaveBeenCalled();
});
+
+ it('keeps the hidden editor input on the selected cell before editing starts', () => {
+ const { controller, documentModel } = createController();
+ const currentEditCellState$ = new Subject<unknown>();
+ const cellEditorSelectionRender = { canFocusing: true, activate: vi.fn(), setInputPosition: vi.fn() };
+ const disposableCollection = { add: vi.fn() };
+
+ controller._editorBridgeService.currentEditCellState$ = currentEditCellState$;
+ controller._editorBridgeService.getEditCellState.mockReturnValue({
+ unitId: 'unit-1',
+ sheetId: 'sheet-1',
+ row: 2,
+ column: 3,
+ documentLayoutObject: { documentModel },
+ editorUnitId: DOCS_NORMAL_EDITOR_UNIT_ID_KEY,
+ position: { startX: 120, startY: 80, endX: 220, endY: 100 },
+ canvasOffset: { left: 30, top: 20 },
+ scaleX: 1,
+ scaleY: 1,
+ });
+ controller._renderManagerService.getRenderUnitById.mockImplementation((unitId: string) => {
+ if (unitId === 'unit-1') {
+ return { engine: { width: 800, height: 600 } };
+ }
+
+ return {
+ with: vi.fn(() => unitId === DOCS_NORMAL_EDITOR_UNIT_ID_KEY ? cellEditorSelectionRender : { canFocusing: false }),
+ };
+ });
+
+ controller._subscribeToCurrentCell(disposableCollection);
+ currentEditCellState$.next({ unitId: 'unit-1' });
+
+ expect(cellEditorSelectionRender.activate).toHaveBeenCalledWith(150, 100, true);
+ expect(cellEditorSelectionRender.setInputPosition).not.toHaveBeenCalled();
+ });
});
diff --git a/packages/sheets-ui/src/controllers/editor/__tests__/editor-utils.spec.ts b/packages/sheets-ui/src/controllers/editor/__tests__/editor-utils.spec.ts
index 78fc9229ab..6b03b3ccf0 100644
--- a/packages/sheets-ui/src/controllers/editor/__tests__/editor-utils.spec.ts
+++ b/packages/sheets-ui/src/controllers/editor/__tests__/editor-utils.spec.ts
@@ -15,6 +15,7 @@
*/
import { describe, expect, it } from 'vitest';
+import { getEditCellInputPosition } from '../utils/get-edit-cell-input-position';
import { EMBEDDING_FORMULA_EDITOR, isEmbeddingFormulaEditor } from '../utils/is-embedding-formula-editor';
import { isRangeSelector, RANGE_SELECTOR_SYMBOLS } from '../utils/is-range-selector';
@@ -28,4 +29,16 @@ describe('editor utils', () => {
expect(isRangeSelector(`abc_${RANGE_SELECTOR_SYMBOLS}_xyz`)).toBe(true);
expect(isRangeSelector('normal-doc-id')).toBe(false);
});
+
+ it('should place the hidden editor input on the edit cell and keep it inside the canvas', () => {
+ const canvasOffset = { left: 30, top: 20 };
+ const canvasSize = { width: 800, height: 600 };
+
+ expect(getEditCellInputPosition({ position: { startX: 120, startY: 80, endX: 220, endY: 100 }, canvasOffset }))
+ .toEqual({ x: 150, y: 100 });
+ expect(getEditCellInputPosition({ position: { startX: 120, startY: 80, endX: 220, endY: 100 }, canvasOffset }, canvasSize))
+ .toEqual({ x: 150, y: 100 });
+ expect(getEditCellInputPosition({ position: { startX: -50, startY: 2000, endX: 50, endY: 2020 }, canvasOffset }, canvasSize))
+ .toEqual({ x: 30, y: 620 });
+ });
});
diff --git a/packages/sheets-ui/src/controllers/editor/editing.render-controller.ts b/packages/sheets-ui/src/controllers/editor/editing.render-controller.ts
index f393c6e7b9..32dd76eb53 100644
--- a/packages/sheets-ui/src/controllers/editor/editing.render-controller.ts
+++ b/packages/sheets-ui/src/controllers/editor/editing.render-controller.ts
@@ -126,6 +126,7 @@ import { EditorBridgeRenderController } from '../render-controllers/editor-bridg
import { MOVE_SELECTION_KEYCODE_LIST } from '../shortcuts/editor.shortcut';
import { extractStringFromForceString, isForceString } from '../utils/cell-tools';
import { normalizeString } from '../utils/char-tools';
+import { getEditCellInputPosition } from './utils/get-edit-cell-input-position';
import { isRangeSelector } from './utils/is-range-selector';
const HIDDEN_EDITOR_POSITION = -1000;
@@ -416,11 +417,10 @@ export class EditingRenderController extends Disposable {
if (this._contextService.getContextValue(DISABLE_AUTO_FOCUS_KEY)) {
cellSelectionRenderManager?.setInputPosition(HIDDEN_EDITOR_POSITION, HIDDEN_EDITOR_POSITION);
} else {
- cellSelectionRenderManager?.activate(
- HIDDEN_EDITOR_POSITION,
- HIDDEN_EDITOR_POSITION,
- true
- );
+ // Keep the hidden input on the selected cell, so the IME candidate window opens next to it
+ // when the user starts typing before the cell editor is visible.
+ const { x, y } = getEditCellInputPosition(state, this._renderManagerService.getRenderUnitById(state.unitId)?.engine);
+ cellSelectionRenderManager?.activate(x, y, true);
}
}
}));
diff --git a/packages/sheets-ui/src/controllers/editor/utils/get-edit-cell-input-position.ts b/packages/sheets-ui/src/controllers/editor/utils/get-edit-cell-input-position.ts
new file mode 100644
index 0000000000..04b323b45c
--- /dev/null
+++ b/packages/sheets-ui/src/controllers/editor/utils/get-edit-cell-input-position.ts
@@ -0,0 +1,43 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Nullable } from '@univerjs/core';
+import type { ICellEditorLayout } from '../../../services/editor-bridge.service';
+
+/**
+ * Get the position of the hidden editor input for the current edit cell.
+ *
+ * The OS anchors the IME candidate window to the focused input, so the input should stay on the
+ * selected cell even before the cell editor opens. The position is kept inside the sheet canvas,
+ * so a cell scrolled out of view never moves the input outside the sheet.
+ */
+export function getEditCellInputPosition(
+ layout: Pick<ICellEditorLayout, 'position' | 'canvasOffset'>,
+ canvasSize?: Nullable<{ width: number; height: number }>
+): { x: number; y: number } {
+ const { position, canvasOffset } = layout;
+ const x = canvasOffset.left + position.startX;
+ const y = canvasOffset.top + position.startY;
+
+ if (!canvasSize) {
+ return { x, y };
+ }
+
+ return {
+ x: Math.min(Math.max(x, canvasOffset.left), canvasOffset.left + canvasSize.width),
+ y: Math.min(Math.max(y, canvasOffset.top), canvasOffset.top + canvasSize.height),
+ };
+}
diff --git a/packages/sheets-ui/src/controllers/render-controllers/__tests__/desktop-cell-edit.render-controller.spec.ts b/packages/sheets-ui/src/controllers/render-controllers/__tests__/desktop-cell-edit.render-controller.spec.ts
index e7778e98fc..4bcd87326b 100644
--- a/packages/sheets-ui/src/controllers/render-controllers/__tests__/desktop-cell-edit.render-controller.spec.ts
+++ b/packages/sheets-ui/src/controllers/render-controllers/__tests__/desktop-cell-edit.render-controller.spec.ts
@@ -27,7 +27,7 @@ import {
IUniverInstanceService,
} from '@univerjs/core';
import { DocSelectionRenderService } from '@univerjs/docs-ui';
-import { DeviceInputEventType, IRenderManagerService } from '@univerjs/engine-render';
+import { DeviceInputEventType, IRenderManagerService, SHEET_VIEWPORT_KEY } from '@univerjs/engine-render';
import { ClearSelectionFormatCommand, SetWorksheetActiveOperation, SheetsSelectionsService } from '@univerjs/sheets';
import { DISABLE_AUTO_FOCUS_KEY, IPlatformService, PlatformService } from '@univerjs/ui';
import { Subject } from 'rxjs';
@@ -103,8 +103,11 @@ function createController(options?: {
const spreadsheetRowHeader = { onPointerDown$: createEventSubject() };
const spreadsheetColumnHeader = { onPointerDown$: createEventSubject() };
const spreadsheetLeftTopPlaceholder = { onPointerDown$: createEventSubject() };
- const scene = {};
- const engine = {};
+ const viewportMain = { onScrollEnd$: createEventSubject() };
+ const scene = {
+ getViewport: vi.fn((key: string) => key === SHEET_VIEWPORT_KEY.VIEW_MAIN ? viewportMain : null),
+ };
+ const engine = { width: 800, height: 600 };
const worksheet = { getSheetId: vi.fn(() => 'sheet-1') };
const workbook = {
getUnitId: vi.fn(() => 'unit-1'),
@@ -158,6 +161,7 @@ function createController(options?: {
isVisible: vi.fn(() => ({ visible: editorVisible })),
isForceKeepVisible: vi.fn(() => options?.forceKeepVisible ?? false),
refreshEditCellState: vi.fn(),
+ refreshEditCellPosition: vi.fn(),
};
commandService.syncExecuteCommand.mockReturnValue(true);
const instanceService = {
@@ -253,6 +257,7 @@ function createController(options?: {
spreadsheetColumnHeader,
spreadsheetLeftTopPlaceholder,
spreadsheetRowHeader,
+ viewportMain,
workbook,
workbook$,
};
@@ -403,6 +408,32 @@ describe('DesktopCellEditRenderController integration with the editor bridge', (
controller.dispose();
});
+ it('keeps the hidden input on the selected cell after the sheet scrolls', () => {
+ const { controller, docSelectionRenderService, editorBridgeService, viewportMain } = createController();
+
+ editorBridgeService.getEditCellLayout.mockReturnValue({
+ position: { startX: 60, startY: 40 },
+ canvasOffset: { left: 30, top: 20 },
+ });
+ viewportMain.onScrollEnd$.emit({});
+
+ expect(editorBridgeService.refreshEditCellPosition).toHaveBeenCalledWith(false);
+ expect(docSelectionRenderService.setInputPosition).toHaveBeenCalledWith(90, 60);
+
+ controller.dispose();
+ });
+
+ it('does not move the hidden input on scroll while the cell editor is visible', () => {
+ const { controller, docSelectionRenderService, editorBridgeService, viewportMain } = createController({ editorVisible: true });
+
+ viewportMain.onScrollEnd$.emit({});
+
+ expect(editorBridgeService.refreshEditCellPosition).not.toHaveBeenCalled();
+ expect(docSelectionRenderService.setInputPosition).not.toHaveBeenCalled();
+
+ controller.dispose();
+ });
+
it('does not reopen mobile editing implicitly when a selection changes', () => {
const { commandService, controller, selectionMoveEnd$, spreadsheet } = createController({
editorVisible: true,
diff --git a/packages/sheets-ui/src/controllers/render-controllers/desktop-cell-edit.render-controller.ts b/packages/sheets-ui/src/controllers/render-controllers/desktop-cell-edit.render-controller.ts
index d203f312c9..51a35fa60f 100644
--- a/packages/sheets-ui/src/controllers/render-controllers/desktop-cell-edit.render-controller.ts
+++ b/packages/sheets-ui/src/controllers/render-controllers/desktop-cell-edit.render-controller.ts
@@ -34,7 +34,7 @@ import {
UniverInstanceType,
} from '@univerjs/core';
import { DocSelectionRenderService } from '@univerjs/docs-ui';
-import { DeviceInputEventType, IRenderManagerService } from '@univerjs/engine-render';
+import { DeviceInputEventType, IRenderManagerService, SHEET_VIEWPORT_KEY } from '@univerjs/engine-render';
import { isCellImage, REF_SELECTIONS_ENABLED, SheetsSelectionsService } from '@univerjs/sheets';
import { DISABLE_AUTO_FOCUS_KEY, getEmbedChildUnitId, IPlatformService } from '@univerjs/ui';
import { filter } from 'rxjs';
@@ -45,6 +45,7 @@ import {
ISheetEmbedRuntimeFocusCoordinator,
SHEET_EMBED_RUNTIME_FOCUS_ROLE_ATTRIBUTE,
} from '../../services/sheet-embed-integration.service';
+import { getEditCellInputPosition } from '../editor/utils/get-edit-cell-input-position';
import { getSheetObject } from '../utils/component-tools';
export class DesktopCellEditRenderController extends RxDisposable implements IRenderModule {
@@ -211,6 +212,19 @@ export class DesktopCellEditRenderController extends RxDisposable implements IRe
this._updateInputPosition();
}
}));
+
+ // The selected cell moves with the viewport, keep the hidden input (and the IME candidate window) on it.
+ const viewportMain = this._context.scene.getViewport(SHEET_VIEWPORT_KEY.VIEW_MAIN);
+ if (viewportMain) {
+ d.add(viewportMain.onScrollEnd$.subscribeEvent(() => {
+ if (this._editorBridgeService.isVisible().visible) {
+ return;
+ }
+
+ this._editorBridgeService.refreshEditCellPosition(false);
+ this._updateInputPosition();
+ }));
+ }
}
private _updateInputPosition(): void {
@@ -226,11 +240,8 @@ export class DesktopCellEditRenderController extends RxDisposable implements IRe
return;
}
- const { position, canvasOffset } = layout;
- docSelectionRenderService.setInputPosition(
- canvasOffset.left + position.startX,
- canvasOffset.top + position.startY
- );
+ const { x, y } = getEditCellInputPosition(layout, this._context.engine);
+ docSelectionRenderService.setInputPosition(x, y);
}
private _focusCellEditorInput(): void {