Skip to content

fix: iOS Safari Chinese punctuation input not working #5614

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

Open
mylukin wants to merge 1 commit into
base: master
Choose a base branch
from
+28 −5
Open

fix: iOS Safari Chinese punctuation input not working #5614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 10 additions & 4 deletions src/browser/CoreBrowserTerminal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1241,10 +1241,16 @@ export class CoreBrowserTerminal extends CoreTerminal implements ITerminal {
* @param ev The input event to be handled.
*/
protected _inputEvent(ev: InputEvent): boolean {
// Only support emoji IMEs when screen reader mode is disabled as the event must bubble up to
// support reading out character input which can doubling up input characters
// Based on these event traces: https://github.com/xtermjs/xterm.js/issues/3679
if (ev.data && ev.inputType === 'insertText' && (!ev.composed || !this._keyDownSeen) && !this.optionsService.rawOptions.screenReaderMode) {
// Handle direct text input (not from composition).
// We skip input events when:
// - isComposing: Active composition in progress (e.g., emoji picker, CJK IME)
// - isSendingComposition: compositionend fired but setTimeout hasn't sent data yet
// CompositionHelper handles input in these cases to prevent duplicates.
// When NOT composing/sending, we accept input even if ev.composed=true, which fixes
// iOS Safari Chinese punctuation input (issue #3070, #4486).
// Screen reader mode needs the event to bubble for accessibility announcements.
const compositionHelper = this._compositionHelper!;
if (ev.data && ev.inputType === 'insertText' && !compositionHelper.isComposing && !compositionHelper.isSendingComposition && !this.optionsService.rawOptions.screenReaderMode) {
if (this._keyPressHandled) {
return false;
}
Expand Down
3 changes: 3 additions & 0 deletions src/browser/TestUtils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -344,6 +344,9 @@ export class MockCompositionHelper implements ICompositionHelper {
public get isComposing(): boolean {
return false;
}
public get isSendingComposition(): boolean {
return false;
}
public compositionstart(): void {
throw new Error('Method not implemented.');
}
Expand Down
1 change: 1 addition & 0 deletions src/browser/Types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ export type LineData = CharData[];

export interface ICompositionHelper {
readonly isComposing: boolean;
readonly isSendingComposition: boolean;
compositionstart(): void;
compositionupdate(ev: CompositionEvent): void;
compositionend(): void;
Expand Down
4 changes: 3 additions & 1 deletion src/browser/input/CompositionHelper.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ export class CompositionHelper {

/**
* Whether a composition is in the process of being sent, setting this to false will cancel any
* in-progress composition.
* in-progress composition. This is true between compositionend and when the setTimeout callback
* fires to actually send the data.
*/
private _isSendingComposition: boolean;
public get isSendingComposition(): boolean { return this._isSendingComposition; }

/**
* Data already sent due to keydown event.
Expand Down