Skip to content

fix: the order of compositionend events varies by browser #1890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 3, 2022
Merged

fix: the order of compositionend events varies by browser #1890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afd00a7
fix: the order of compositionend events varies by browser
Oct 1, 2022
0e8b6d2
apply our style conventions
RobinMalfait Nov 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion packages/@headlessui-react/src/components/combobox/combobox.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,16 @@ let Input = forwardRefWithAs(function Input<
[currentValue, data.comboboxState]
)

let isComposing = useRef(false)
let handleCompositionStart = useEvent(() => {
isComposing.current = true
})
let handleCompositionEnd = useEvent(() => {
setTimeout(() => {
isComposing.current = false
})
})

let handleKeyDown = useEvent((event: ReactKeyboardEvent<HTMLInputElement>) => {
switch (event.key) {
// Ref: https://www.w3.org/TR/wai-aria-practices-1.2/#keyboard-interaction-12
Expand All @@ -713,7 +723,7 @@ let Input = forwardRefWithAs(function Input<

case Keys.Enter:
if (data.comboboxState !== ComboboxState.Open) return
if (event.nativeEvent.isComposing) return
if (isComposing.current) return

event.preventDefault()
event.stopPropagation()
Expand Down Expand Up @@ -815,6 +825,8 @@ let Input = forwardRefWithAs(function Input<
'aria-multiselectable': data.mode === ValueMode.Multi ? true : undefined,
'aria-labelledby': labelledby,
disabled: data.disabled,
onCompositionStart: handleCompositionStart,
onCompositionEnd: handleCompositionEnd,
onKeyDown: handleKeyDown,
onChange: handleChange,
}
Expand Down
16 changes: 14 additions & 2 deletions packages/@headlessui-vue/src/components/combobox/combobox.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -630,7 +630,7 @@ export let ComboboxInput = defineComponent({
}

// Workaround Vue bug where watching [ref(undefined)] is not fired immediately even when value is true
const __fixVueImmediateWatchBug__ = ref('')
let __fixVueImmediateWatchBug__ = ref('')

onMounted(() => {
watch(
Expand Down Expand Up @@ -659,6 +659,16 @@ export let ComboboxInput = defineComponent({
)
})

let isComposing = ref(false)
function handleCompositionstart() {
isComposing.value = true
}
function handleCompositionend() {
setTimeout(() => {
isComposing.value = false
})
}

function handleKeyDown(event: KeyboardEvent) {
switch (event.key) {
// Ref: https://www.w3.org/TR/wai-aria-practices-1.2/#keyboard-interaction-12
Expand All @@ -683,7 +693,7 @@ export let ComboboxInput = defineComponent({

case Keys.Enter:
if (api.comboboxState.value !== ComboboxStates.Open) return
if (event.isComposing) return
if (isComposing.value) return

event.preventDefault()
event.stopPropagation()
Expand Down Expand Up @@ -774,6 +784,8 @@ export let ComboboxInput = defineComponent({
'aria-multiselectable': api.mode.value === ValueMode.Multi ? true : undefined,
'aria-labelledby': dom(api.labelRef)?.id ?? dom(api.buttonRef)?.id,
id,
onCompositionstart: handleCompositionstart,
onCompositionend: handleCompositionend,
onKeydown: handleKeyDown,
onChange: handleChange,
onInput: handleInput,
Expand Down