Skip to content

Commit 0b0456a

Browse files
fix(AiDock): ignore Enter during IME composition (#1365)
* fix(AiDock): ignore Enter during IME composition The dock input submits on any Enter keydown. With an IME, Enter is also the key that confirms a conversion, so the question is sent while the user is still composing. It also leaves text behind: submitQuestion() clears the field, but the IME commit is still pending, so the committed text lands in the now-empty input. Check event.nativeEvent.isComposing before submitting, matching RetryComposer, DraftBot, CommandPalette, ComposerReferences and ConversationSession. Fixes #1362 * fix(AiDock): also skip IME Enter that arrives after compositionend Safari fires compositionend before the Enter keydown for Chinese and Japanese input, so isComposing is already false there. keyCode is still 229 on that keydown, so check it as well. Move the check into submitOnEnter() in src/utils/ai-dock-enter.ts so it can be tested. AiDock.tsx can't be imported under tsx --test because of its .svg imports. Related to #1362 --------- Co-authored-by: Tanner Linsley <tannerlinsley@gmail.com>
1 parent 2f62e9e commit 0b0456a

3 files changed

Lines changed: 58 additions & 6 deletions

File tree

‎src/components/AiDock.tsx‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ import { CodeBlock } from '~/components/markdown/CodeBlock'
4545
import { copyTextToClipboard } from '~/utils/browser-effects'
4646
import { InlineCode } from '~/ui/InlineCode'
4747
import { isSafeHref } from '~/utils/url-boundary'
48+
import { submitOnEnter } from '~/utils/ai-dock-enter'
4849
import {
4950
type AlgoliaHit,
5051
dedupeSearchHitsByPage,
@@ -1988,12 +1989,7 @@ function InputBar({
19881989
setSearchQuery(nextQuery)
19891990
refine(nextQuery)
19901991
}}
1991-
onKeyDown={(event) => {
1992-
if (event.key === 'Enter') {
1993-
event.preventDefault()
1994-
submitQuestion()
1995-
}
1996-
}}
1992+
onKeyDown={(event) => submitOnEnter(event, submitQuestion)}
19971993
className={twMerge(
19981994
'w-full outline-none [&::-webkit-search-cancel-button]:hidden bg-transparent text-gray-800 dark:text-gray-100 placeholder:text-gray-400 dark:placeholder:text-gray-500',
19991995
isDock ? 'text-[13px]' : 'text-sm',

‎src/utils/ai-dock-enter.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
type EnterKeyEvent = {
2+
key: string
3+
nativeEvent: Pick<KeyboardEvent, 'isComposing' | 'keyCode'>
4+
preventDefault: () => void
5+
}
6+
7+
export function submitOnEnter(event: EnterKeyEvent, submit: () => void) {
8+
if (
9+
event.key !== 'Enter' ||
10+
event.nativeEvent.isComposing ||
11+
// Safari can fire compositionend before this keydown, so isComposing is
12+
// already false. keyCode is deprecated, but it is still 229 here.
13+
event.nativeEvent.keyCode === 229
14+
) {
15+
return
16+
}
17+
event.preventDefault()
18+
submit()
19+
}

‎tests/ai-dock-enter.test.ts‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import assert from 'node:assert/strict'
2+
import test from 'node:test'
3+
import { submitOnEnter } from '../src/utils/ai-dock-enter'
4+
5+
function press(key: string, isComposing: boolean, keyCode: number) {
6+
let prevented = 0
7+
let submitted = 0
8+
submitOnEnter(
9+
{
10+
key,
11+
nativeEvent: { isComposing, keyCode },
12+
preventDefault: () => {
13+
prevented++
14+
},
15+
},
16+
() => {
17+
submitted++
18+
},
19+
)
20+
return { prevented, submitted }
21+
}
22+
23+
test('Enter during composition neither submits nor prevents default', () => {
24+
assert.deepEqual(press('Enter', true, 13), { prevented: 0, submitted: 0 })
25+
})
26+
27+
test('Enter with isComposing=false and keyCode=229 neither submits nor prevents default', () => {
28+
assert.deepEqual(press('Enter', false, 229), { prevented: 0, submitted: 0 })
29+
})
30+
31+
test('ordinary Enter submits once', () => {
32+
assert.deepEqual(press('Enter', false, 13), { prevented: 1, submitted: 1 })
33+
})
34+
35+
test('non-Enter key does not submit', () => {
36+
assert.deepEqual(press('a', false, 65), { prevented: 0, submitted: 0 })
37+
})

0 commit comments

Comments
 (0)