Skip to content

feat: Prevent onChange from firing in TextFields while user is typing via IME #8519

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 4 commits into from
Jul 10, 2025
Merged

feat: Prevent onChange from firing in TextFields while user is typing via IME #8519

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dc11e0a
feat: block onChange from firing until composition end
LFDanLu Jul 10, 2025
c8fb1e9
fix lint
LFDanLu Jul 10, 2025
56c4055
fix extra onChange when deleting IME input
LFDanLu Jul 10, 2025
1d464a3
review comments
LFDanLu Jul 10, 2025
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
34 changes: 29 additions & 5 deletions packages/@react-aria/textfield/src/useTextField.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,17 @@
*/

import {AriaTextFieldProps} from '@react-types/textfield';
import {chain, filterDOMProps, getOwnerWindow, mergeProps, useFormReset} from '@react-aria/utils';
import {DOMAttributes, ValidationResult} from '@react-types/shared';
import {filterDOMProps, getOwnerWindow, mergeProps, useFormReset} from '@react-aria/utils';
import React, {
ChangeEvent,
HTMLAttributes,
type JSX,
LabelHTMLAttributes,
RefObject,
useCallback,
useEffect,
useRef,
useState
} from 'react';
import {useControlledState} from '@react-stately/utils';
Expand Down Expand Up @@ -122,9 +124,20 @@ export function useTextField<T extends TextFieldIntrinsicElements = DefaultEleme
isRequired = false,
isReadOnly = false,
type = 'text',
validationBehavior = 'aria'
validationBehavior = 'aria',
onChange: onChangeProp
} = props;
let [value, setValue] = useControlledState<string>(props.value, props.defaultValue || '', props.onChange);

let isComposing = useRef(false);
let onChange = useCallback((val) => {
if (isComposing.current) {
return;
}

onChangeProp?.(val);
}, [onChangeProp]);

let [value, setValue] = useControlledState<string>(props.value, props.defaultValue || '', onChange);
let {focusableProps} = useFocusable<TextFieldHTMLElementType[T]>(props, ref);
let validationState = useFormValidationState({
...props,
Expand Down Expand Up @@ -165,6 +178,17 @@ export function useTextField<T extends TextFieldIntrinsicElements = DefaultEleme
}
}, [ref]);

let onCompositionStart = useCallback(() => {
isComposing.current = true;
}, []);

let onCompositionEnd = useCallback((e) => {
isComposing.current = false;
if (e.data !== '') {
onChangeProp?.(value);
}
}, [onChangeProp, value]);

return {
labelProps,
inputProps: mergeProps(
Expand Down Expand Up @@ -201,8 +225,8 @@ export function useTextField<T extends TextFieldIntrinsicElements = DefaultEleme
onPaste: props.onPaste,

// Composition events
onCompositionEnd: props.onCompositionEnd,
onCompositionStart: props.onCompositionStart,
onCompositionEnd: chain(onCompositionEnd, props.onCompositionEnd),
onCompositionStart: chain(onCompositionStart, props.onCompositionStart),
onCompositionUpdate: props.onCompositionUpdate,

// Selection events
Expand Down