Skip to content

Commit 34c5a6d

Browse files
authored
fix(web): detect software keyboard before handling composer Enter (pingdotgg#21763)
1 parent 7e7e6d8 commit 34c5a6d

7 files changed

Lines changed: 330 additions & 7 deletions

File tree

‎apps/web/src/components/chat/ChatComposer.tsx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1103,6 +1103,7 @@ import {
11031103
import { searchProviderSkills } from "../../providerSkillSearch";
11041104
import { useDelayedStatus } from "../../hooks/useDelayedStatus";
11051105
import { useMediaQuery } from "../../hooks/useMediaQuery";
1106+
import { useSoftwareKeyboardOpen } from "../../hooks/useSoftwareKeyboardOpen";
11061107
import { useStableCallback } from "../../hooks/useStableCallback";
11071108
import { usePanelAnimationSettings } from "../../panelAnimations";
11081109
import { useAtomCommand } from "../../state/use-atom-command";
@@ -2415,6 +2416,7 @@ export const ChatComposer = memo(function ChatComposer(props: ChatComposerProps)
24152416
const [isComposerPrimaryActionsCompact, setIsComposerPrimaryActionsCompact] = useState(false);
24162417
const [isComposerModelPickerOpen, setIsComposerModelPickerOpen] = useState(false);
24172418
const isMobileViewport = useMediaQuery("max-sm");
2419+
const isSoftwareKeyboardOpen = useSoftwareKeyboardOpen();
24182420
const {
24192421
isComposerFocused,
24202422
setIsComposerFocused,
@@ -3917,7 +3919,7 @@ export const ChatComposer = memo(function ChatComposer(props: ChatComposerProps)
39173919
};
39183920

39193921
const blurMobileComposerAfterSend = () => {
3920-
if (!isMobileViewport) return;
3922+
if (!isSoftwareKeyboardOpen) return;
39213923
if (composerBlurFrameRef.current !== null) {
39223924
window.cancelAnimationFrame(composerBlurFrameRef.current);
39233925
composerBlurFrameRef.current = null;
@@ -3930,7 +3932,7 @@ export const ChatComposer = memo(function ChatComposer(props: ChatComposerProps)
39303932
};
39313933

39323934
const shouldBlurMobileComposerOnSubmit = () => {
3933-
if (!isMobileViewport) return false;
3935+
if (!isSoftwareKeyboardOpen) return false;
39343936
if (
39353937
isSendBusy ||
39363938
isSendDisabled ||
@@ -4147,7 +4149,7 @@ export const ChatComposer = memo(function ChatComposer(props: ChatComposerProps)
41474149
const submissionIntent = composerSubmissionIntentForKey({
41484150
event,
41494151
keybindings,
4150-
isMobileViewport,
4152+
isSoftwareKeyboardOpen,
41514153
isDraftThread: routeKind === "draft",
41524154
isRunning: phase === "running",
41534155
sendShortcut: settings.sendShortcut,

‎apps/web/src/composer-logic.test.ts‎

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ describe("composerSubmissionIntentForKey", () => {
7272
const input = {
7373
keybindings: DEFAULT_RESOLVED_KEYBINDINGS,
7474
platform: "Linux",
75-
isMobileViewport: false,
75+
isSoftwareKeyboardOpen: false,
7676
isDraftThread: false,
7777
};
7878
const enter = { key: "Enter", metaKey: false, ctrlKey: false, altKey: false, shiftKey: false };
@@ -292,8 +292,29 @@ describe("composerSubmissionIntentForKey", () => {
292292
},
293293
);
294294

295+
it.each(["MacIntel", "Win32", "Linux"])(
296+
"keeps modifier submission available with the software keyboard open on %s",
297+
(platform) => {
298+
const modEnter = {
299+
...enter,
300+
metaKey: platform === "MacIntel",
301+
ctrlKey: platform !== "MacIntel",
302+
};
303+
const keyboardOpen = { ...input, platform, isSoftwareKeyboardOpen: true };
304+
expect(composerSubmissionIntentForKey({ ...keyboardOpen, event: modEnter })).toBe(
305+
"foreground",
306+
);
307+
expect(
308+
composerSubmissionIntentForKey({ ...keyboardOpen, isRunning: true, event: modEnter }),
309+
).toBe("alternate");
310+
expect(
311+
composerSubmissionIntentForKey({ ...keyboardOpen, isDraftThread: true, event: modEnter }),
312+
).toBe("background");
313+
},
314+
);
315+
295316
it.each([
296-
{ isMobileViewport: true },
317+
{ isSoftwareKeyboardOpen: true },
297318
{ event: { ...enter, isComposing: true } },
298319
{ event: { ...enter, keyCode: 229 } },
299320
{ event: { ...enter, repeat: true } },

‎apps/web/src/composer-logic.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,15 @@ export function composerSubmissionIntentForKey(input: {
4141
event: ShortcutEventLike & { isComposing?: boolean; keyCode?: number; repeat?: boolean };
4242
keybindings: ResolvedKeybindingsConfig;
4343
platform?: string;
44-
isMobileViewport: boolean;
44+
isSoftwareKeyboardOpen: boolean;
4545
isDraftThread: boolean;
4646
isRunning?: boolean;
4747
sendShortcut?: ClientSettings["sendShortcut"];
4848
prompt?: string;
4949
}): ComposerSubmissionIntent | null {
5050
const { event } = input;
51-
if (input.isMobileViewport || event.isComposing || event.keyCode === 229 || event.repeat)
51+
if (event.isComposing || event.keyCode === 229 || event.repeat) return null;
52+
if (input.isSoftwareKeyboardOpen && event.key === "Enter" && !event.metaKey && !event.ctrlKey)
5253
return null;
5354
const command = resolveShortcutCommand(event, input.keybindings, {
5455
...(input.platform === undefined ? {} : { platform: input.platform }),
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import { useSyncExternalStore } from "react";
2+
3+
import { isElectron } from "../env";
4+
import { createSoftwareKeyboardStore } from "../lib/softwareKeyboard";
5+
6+
const store = createSoftwareKeyboardStore(
7+
typeof window === "undefined" ? undefined : window,
8+
isElectron,
9+
);
10+
11+
function getServerSnapshot() {
12+
return false;
13+
}
14+
15+
export function useSoftwareKeyboardOpen() {
16+
return useSyncExternalStore(store.subscribe, store.getSnapshot, getServerSnapshot);
17+
}
Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
import { describe, expect, it, vi } from "vite-plus/test";
2+
3+
import { createSoftwareKeyboardStore } from "./softwareKeyboard";
4+
5+
function fixture(options: { native?: boolean; overlay?: boolean; desktop?: boolean } = {}) {
6+
const viewport = Object.assign(new EventTarget(), { width: 390, height: 844, scale: 1 });
7+
const keyboard = Object.assign(new EventTarget(), {
8+
boundingRect: { height: 0 },
9+
overlaysContent: options.overlay ?? false,
10+
});
11+
const win = {
12+
innerHeight: 844,
13+
visualViewport: viewport,
14+
navigator: options.native ? { virtualKeyboard: keyboard } : {},
15+
};
16+
const store = createSoftwareKeyboardStore(win as unknown as Window, options.desktop ?? false);
17+
const resize = (height: number, width = viewport.width, scale = viewport.scale) => {
18+
Object.assign(viewport, { height, width, scale });
19+
viewport.dispatchEvent(new Event("resize"));
20+
};
21+
const geometry = (height: number) => {
22+
keyboard.boundingRect.height = height;
23+
keyboard.dispatchEvent(new Event("geometrychange"));
24+
};
25+
return { store, viewport, keyboard, win, resize, geometry };
26+
}
27+
28+
describe("software keyboard detection", () => {
29+
it("follows native keyboard geometry even when the viewport does not resize", () => {
30+
const { store, geometry } = fixture({ native: true, overlay: true });
31+
const observed: boolean[] = [];
32+
const unsubscribe = store.subscribe(() => observed.push(store.getSnapshot()));
33+
expect(store.getSnapshot()).toBe(false);
34+
35+
geometry(300);
36+
expect(store.getSnapshot()).toBe(true);
37+
geometry(0);
38+
expect(store.getSnapshot()).toBe(false);
39+
expect(observed).toEqual([true, false]);
40+
41+
unsubscribe();
42+
geometry(300);
43+
expect(observed).toEqual([true, false]);
44+
});
45+
46+
it("reads keyboard geometry that was already present before subscribing", () => {
47+
const { store, keyboard } = fixture({ native: true });
48+
keyboard.boundingRect.height = 300;
49+
expect(store.getSnapshot()).toBe(true);
50+
});
51+
52+
it("prefers overlay geometry over a misleading viewport height", () => {
53+
const { store, resize, geometry } = fixture({ native: true, overlay: true });
54+
const unsubscribe = store.subscribe(() => {});
55+
resize(500);
56+
expect(store.getSnapshot()).toBe(false);
57+
geometry(300);
58+
expect(store.getSnapshot()).toBe(true);
59+
geometry(0);
60+
expect(store.getSnapshot()).toBe(false);
61+
unsubscribe();
62+
});
63+
64+
it.each([false, true])("falls back to viewport changes with native API present: %s", (native) => {
65+
const { store, resize, keyboard } = fixture({ native });
66+
const unsubscribe = store.subscribe(() => {});
67+
68+
resize(500);
69+
expect(store.getSnapshot()).toBe(true);
70+
resize(550);
71+
expect(store.getSnapshot()).toBe(true);
72+
resize(844);
73+
expect(store.getSnapshot()).toBe(false);
74+
expect(keyboard.overlaysContent).toBe(false);
75+
unsubscribe();
76+
});
77+
78+
it("detects a docked keyboard when subscribing after it has opened", () => {
79+
const { store, resize } = fixture();
80+
resize(500);
81+
const unsubscribe = store.subscribe(() => {});
82+
expect(store.getSnapshot()).toBe(true);
83+
resize(844);
84+
expect(store.getSnapshot()).toBe(false);
85+
unsubscribe();
86+
});
87+
88+
it("ignores small height changes such as the browser toolbar", () => {
89+
const { store, resize } = fixture();
90+
const unsubscribe = store.subscribe(() => {});
91+
resize(750);
92+
expect(store.getSnapshot()).toBe(false);
93+
resize(700);
94+
expect(store.getSnapshot()).toBe(false);
95+
unsubscribe();
96+
});
97+
98+
it("ignores window resizing even with a large height change", () => {
99+
const { store, resize, win } = fixture();
100+
const unsubscribe = store.subscribe(() => {});
101+
win.innerHeight = 500;
102+
resize(500);
103+
expect(store.getSnapshot()).toBe(false);
104+
unsubscribe();
105+
});
106+
107+
it("ignores pinch zoom and recognizes keyboard changes at the new scale", () => {
108+
const { store, resize } = fixture();
109+
const unsubscribe = store.subscribe(() => {});
110+
resize(422, 195, 2);
111+
expect(store.getSnapshot()).toBe(false);
112+
resize(300);
113+
expect(store.getSnapshot()).toBe(true);
114+
resize(422);
115+
expect(store.getSnapshot()).toBe(false);
116+
unsubscribe();
117+
});
118+
119+
it("does not mistake an already zoomed viewport for an open keyboard", () => {
120+
const { store, resize } = fixture();
121+
resize(422, 195, 2);
122+
const unsubscribe = store.subscribe(() => {});
123+
expect(store.getSnapshot()).toBe(false);
124+
unsubscribe();
125+
});
126+
127+
it("does not mistake rotation for an open keyboard", () => {
128+
const { store, resize, win } = fixture();
129+
const unsubscribe = store.subscribe(() => {});
130+
win.innerHeight = 390;
131+
resize(390, 844);
132+
expect(store.getSnapshot()).toBe(false);
133+
unsubscribe();
134+
});
135+
136+
it("shares listeners and refreshes state after the final subscriber leaves", () => {
137+
const { store, resize } = fixture();
138+
const first = vi.fn();
139+
const second = vi.fn();
140+
const unsubscribeFirst = store.subscribe(first);
141+
const unsubscribeSecond = store.subscribe(second);
142+
resize(500);
143+
expect(store.getSnapshot()).toBe(true);
144+
expect(first).toHaveBeenCalledOnce();
145+
expect(second).toHaveBeenCalledOnce();
146+
unsubscribeFirst();
147+
resize(550);
148+
expect(first).toHaveBeenCalledOnce();
149+
expect(second).toHaveBeenCalledTimes(2);
150+
unsubscribeSecond();
151+
resize(844);
152+
expect(second).toHaveBeenCalledTimes(2);
153+
154+
const unsubscribe = store.subscribe(first);
155+
expect(store.getSnapshot()).toBe(false);
156+
unsubscribe();
157+
});
158+
159+
it("recognizes keyboard closure despite viewport rounding at high zoom", () => {
160+
const { store, resize } = fixture();
161+
resize(211, 98, 4);
162+
const unsubscribe = store.subscribe(() => {});
163+
resize(150);
164+
expect(store.getSnapshot()).toBe(true);
165+
resize(210.6);
166+
expect(store.getSnapshot()).toBe(false);
167+
unsubscribe();
168+
});
169+
170+
it("bypasses both native geometry and viewport detection on desktop", () => {
171+
const { store, geometry, resize } = fixture({ native: true, overlay: true, desktop: true });
172+
const listener = vi.fn();
173+
const unsubscribe = store.subscribe(listener);
174+
geometry(300);
175+
resize(500);
176+
expect(store.getSnapshot()).toBe(false);
177+
expect(listener).not.toHaveBeenCalled();
178+
unsubscribe();
179+
});
180+
181+
it("does not require browser APIs during server rendering", () => {
182+
const store = createSoftwareKeyboardStore(undefined, false);
183+
const unsubscribe = store.subscribe(() => {});
184+
expect(store.getSnapshot()).toBe(false);
185+
unsubscribe();
186+
});
187+
});
Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
type VirtualKeyboard = EventTarget & {
2+
readonly boundingRect: Pick<DOMRectReadOnly, "height">;
3+
readonly overlaysContent: boolean;
4+
};
5+
6+
type KeyboardWindow = Pick<Window, "innerHeight" | "visualViewport"> & {
7+
readonly navigator: Navigator & { readonly virtualKeyboard?: VirtualKeyboard };
8+
};
9+
10+
const KEYBOARD_THRESHOLD = 150;
11+
12+
function viewportSnapshot(viewport: VisualViewport) {
13+
return {
14+
width: Math.round(viewport.width),
15+
height: Math.round(viewport.height),
16+
scale: viewport.scale,
17+
};
18+
}
19+
20+
export function createSoftwareKeyboardStore(win: KeyboardWindow | undefined, isDesktop: boolean) {
21+
const listeners = new Set<() => void>();
22+
let viewportOpen = false;
23+
const viewport = isDesktop ? undefined : win?.visualViewport;
24+
const keyboard = isDesktop ? undefined : win?.navigator.virtualKeyboard;
25+
let previous = viewport ? viewportSnapshot(viewport) : undefined;
26+
27+
const getSnapshot = () => {
28+
// Chromium can expose the API while withholding geometry outside overlay mode.
29+
// Keep the browser's automatic viewport resizing instead of enabling overlays.
30+
if (keyboard && (keyboard.overlaysContent || keyboard.boundingRect.height > 0)) {
31+
return keyboard.boundingRect.height > 0;
32+
}
33+
return viewportOpen;
34+
};
35+
36+
const notify = () => {
37+
for (const listener of listeners) listener();
38+
};
39+
40+
const onViewportResize = () => {
41+
if (!viewport || !win) return;
42+
const current = viewportSnapshot(viewport);
43+
// Adapted from Ionic's keyboard assist, MIT, Copyright (c) 2015-present Drifty Co.
44+
// https://github.com/ionic-team/ionic-framework/blob/main/core/src/utils/keyboard/keyboard.ts
45+
const scaledHeightDifference = previous
46+
? (previous.height - current.height) * current.scale
47+
: 0;
48+
if (Math.abs(current.height - win.innerHeight / current.scale) <= 1) {
49+
viewportOpen = false;
50+
} else if (
51+
!viewportOpen &&
52+
previous?.width === current.width &&
53+
scaledHeightDifference > KEYBOARD_THRESHOLD
54+
) {
55+
viewportOpen = true;
56+
}
57+
previous = current;
58+
notify();
59+
};
60+
61+
const subscribe = (listener: () => void) => {
62+
if (isDesktop || !win) return () => {};
63+
if (listeners.size === 0) {
64+
if (viewport) {
65+
previous = viewportSnapshot(viewport);
66+
// A composer can mount after the keyboard has already opened.
67+
viewportOpen = win.innerHeight - previous.height * previous.scale > KEYBOARD_THRESHOLD;
68+
viewport.addEventListener("resize", onViewportResize);
69+
}
70+
keyboard?.addEventListener("geometrychange", notify);
71+
}
72+
listeners.add(listener);
73+
return () => {
74+
listeners.delete(listener);
75+
if (listeners.size === 0) {
76+
viewport?.removeEventListener("resize", onViewportResize);
77+
keyboard?.removeEventListener("geometrychange", notify);
78+
}
79+
};
80+
};
81+
82+
return { getSnapshot, subscribe };
83+
}

0 commit comments

Comments
 (0)