Skip to content

The IDE you know, rebuilt in Rust. IntelliJ IDEA–style keymap, tool windows and search-everywhere in a fast native app: editor, code insight, debugger, Git, terminal, database and HTTP clients for 60+ languages.

fix(editor): keep IME keys away from every text field's key handlers (#2364)

ntbang090184cfac9c1741
diff --git a/src/main.tsx b/src/main.tsx
index ff3aabc82..f1b019cdf 100644
--- a/src/main.tsx
+++ b/src/main.tsx
@@ -18,6 +18,7 @@ import { installErrorLogging, logError } from "./platform/errorLog";
import { guessOs } from "./platform/platformInfo";
import { installReorderedTapClick } from "./platform/reordered-tap-click";
import { installPageSwipeTracking } from "./platform/pageSwipe";
+import { installImeKeyGuard } from "./platform/ime";
import { installKeyboardDispatcher } from "./platform/keymap";
import { installPointerFocus } from "./platform/pointerFocus";
import { isTauri } from "./platform/ipc";
@@ -39,6 +40,7 @@ installRepeatedDoubleClick();
if (guessOs() === "macos" && !/Chrome|Firefox/.test(navigator.userAgent)) installReorderedTapClick();
installWindowDrag();
installPointerFocus();
+installImeKeyGuard();
installErrorLogging();
installPageSwipeTracking(window);
diff --git a/src/platform/ime.test.ts b/src/platform/ime.test.ts
new file mode 100644
index 000000000..d8e774c87
--- /dev/null
+++ b/src/platform/ime.test.ts
@@ -0,0 +1,77 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { installImeKeyGuard } from "./ime";
+
+let uninstall: () => void;
+let seen: KeyboardEvent[];
+const onKey = (e: KeyboardEvent) => seen.push(e);
+
+beforeEach(() => {
+ document.body.innerHTML = `
+ <input id="field" />
+ <textarea id="area"></textarea>
+ <div class="xterm"><textarea id="xterm"></textarea></div>
+ <div id="editor" contenteditable="true"></div>`;
+ seen = [];
+ uninstall = installImeKeyGuard(window);
+ document.addEventListener("keydown", onKey);
+ window.addEventListener("keydown", onKey, true);
+});
+afterEach(() => {
+ uninstall();
+ document.removeEventListener("keydown", onKey);
+ window.removeEventListener("keydown", onKey, true);
+});
+
+const el = (id: string) => document.getElementById(id)!;
+const press = (id: string, init: KeyboardEventInit & { keyCode?: number }) => {
+ const event = new KeyboardEvent("keydown", { bubbles: true, cancelable: true, ...init });
+ el(id).dispatchEvent(event);
+ return event;
+};
+
+describe("installImeKeyGuard", () => {
+ it("hides the Enter that commits a candidate (keyCode 229, isComposing already false) from a text field", () => {
+ const handler = vi.fn();
+ el("field").addEventListener("keydown", handler);
+ press("field", { key: "Enter", keyCode: 229 });
+ expect(handler).not.toHaveBeenCalled();
+ // Later window-level capture listeners (shortcuts, Esc-to-close) are cut off too.
+ expect(seen).toHaveLength(0);
+ });
+
+ it("hides keys pressed while composing, on <textarea> too", () => {
+ const handler = vi.fn();
+ el("area").addEventListener("keydown", handler);
+ press("area", { key: "ArrowDown", isComposing: true });
+ expect(handler).not.toHaveBeenCalled();
+ });
+
+ it("does not cancel the default action, so the input method keeps working", () => {
+ expect(press("field", { key: "Enter", keyCode: 229 }).defaultPrevented).toBe(false);
+ });
+
+ it("passes ordinary keys through", () => {
+ const handler = vi.fn();
+ el("field").addEventListener("keydown", handler);
+ press("field", { key: "Enter", keyCode: 13 });
+ expect(handler).toHaveBeenCalledTimes(1);
+ });
+
+ it("leaves xterm's textarea and contenteditable editors to their own IME handling", () => {
+ const handler = vi.fn();
+ el("xterm").addEventListener("keydown", handler);
+ el("editor").addEventListener("keydown", handler);
+ press("xterm", { key: "Enter", keyCode: 229 });
+ press("editor", { key: "Enter", keyCode: 229 });
+ expect(handler).toHaveBeenCalledTimes(2);
+ });
+
+ it("stops listening once uninstalled", () => {
+ uninstall();
+ const handler = vi.fn();
+ el("field").addEventListener("keydown", handler);
+ press("field", { key: "Enter", keyCode: 229 });
+ expect(handler).toHaveBeenCalledTimes(1);
+ uninstall = installImeKeyGuard(window);
+ });
+});
diff --git a/src/platform/ime.ts b/src/platform/ime.ts
index 389e1324f..b497f0090 100644
--- a/src/platform/ime.ts
+++ b/src/platform/ime.ts
@@ -6,3 +6,23 @@
export function isImeKey(e: KeyboardEvent): boolean {
return e.isComposing || e.keyCode === 229;
}
+
+function isPlainTextField(target: EventTarget | null): boolean {
+ if (!(target instanceof HTMLInputElement || target instanceof HTMLTextAreaElement)) return false;
+ // xterm's hidden textarea has its own IME handling (features/terminal/imeInput.ts).
+ return !target.closest(".xterm");
+}
+
+/**
+ * Keeps IME keys away from every handler of an `<input>` / `<textarea>`. Each handler that
+ * reacts to Enter, arrows or Escape must otherwise guard with {@link isImeKey} itself, and
+ * the ones that forget run the key that picks a candidate (Replace, run a line, check out a
+ * branch, commit a cell edit). Default actions are untouched, so the input method still works.
+ */
+export function installImeKeyGuard(target: Window = window): () => void {
+ const onKeyDown = (e: KeyboardEvent) => {
+ if (isImeKey(e) && isPlainTextField(e.target)) e.stopImmediatePropagation();
+ };
+ target.addEventListener("keydown", onKeyDown, true);
+ return () => target.removeEventListener("keydown", onKeyDown, true);
+}