Skip to content

expose IME composing range in QuillController #2679

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

expose IME composing range in QuillController #2679

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
15 changes: 15 additions & 0 deletions lib/src/controller/quill_controller.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import 'dart:math' as math;

import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart' show ClipboardData, Clipboard;
import 'package:flutter/widgets.dart';
import 'package:meta/meta.dart';
Expand Down Expand Up @@ -48,6 +49,20 @@ class QuillController extends ChangeNotifier {
selection: const TextSelection.collapsed(offset: 0),
);

// Expose current IME composing range for filtering out intermediate edits.
final ValueNotifier<TextRange> _composingRangeNotifier =
ValueNotifier<TextRange>(TextRange.empty);

/// Current IME (Chinese/Japanese etc input method) composing range.
/// This can be used to filter out intermediate edits that happen during IME composition.
ValueListenable<TextRange> get composing => _composingRangeNotifier;

@internal
void setComposingRange(TextRange range) {
if (_composingRangeNotifier.value == range) return;
_composingRangeNotifier.value = range;
}

final QuillControllerConfig config;

/// Document managed by this controller.
Expand Down
7 changes: 5 additions & 2 deletions lib/src/editor/raw_editor/raw_editor_state_text_input_client_mixin.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,11 @@ mixin RawEditorStateTextInputClientMixin on EditorState

set _lastKnownRemoteTextEditingValue(TextEditingValue? value) {
__lastKnownRemoteTextEditingValue = value;
if (composingRange.value != value?.composing) {
composingRange.value = value?.composing ?? TextRange.empty;
final newRange = value?.composing ?? TextRange.empty;
if (composingRange.value != newRange) {
composingRange.value = newRange;
// Forward composing range to the controller
widget.controller.setComposingRange(newRange);
}
}

Expand Down