chore: improve changes application from TextInputClient #2510

CatHood0 · 2025-03-12T00:41:37Z

Description

Previously, our TextInputClient implementation only allowed for one specific action during the updateEditingValue call: applying the new (or removed) text to the document. However, it didn't have good support for CharacterShorcutEvents when applying them to virtual keyboards.

For this purpose, a new implementation was created that allows for more explicit retrieval of the type of change made to the document/text and for simple application.

This description will be updated soon to provide more information on why it was done this way.

Note

This PR fixes the issue where the cursor isn't synchronized with keyboard events and positions the caret in places it shouldn't. I've at least tried reproducing the issue on physical devices, and it seems to have been completely eliminated. I'll have to test whether this issue has also been resolved on emulators.

Related Issues

Fix: ShortcutEvents are not working on mobile platform. #2370

Type of Change

✨ Feature: New functionality without breaking existing features.
🛠️ Bug fix: Resolves an issue without altering current behavior.
🧹 Refactor: Code reorganization, no behavior change.
❌ Breaking: Alters existing functionality and requires updates.
🧪 Tests: New or modified tests
📝 Documentation: Updates or additions to documentation.
🗑️ Chore: Routine tasks, or maintenance.
✅ Build configuration change: Build/configuration changes.

TODO

check if works for all platforms (i'll need some help with apple OS)
fix buggy behavior on deletion operations in web browsers
fix buggy behavior in android (the caret is not synced with the TextEditingValue passed)

…single delta

…ingerdmx#2483) * docs: update controller length extension method deprecation message * docs: update changelog

Co-authored-by: CatHood0 <santiagowmar@gmail.com>

…mx#2484)

…ute (singerdmx#2438) * feat: Enable BoxDecoration for DefaultTextBlockStyle of header Attribute --------- Co-authored-by: Ellet <echo.ellet@gmail.com>

… of page route changing when editor is set to readonly. (singerdmx#2488) Co-authored-by: chaos <chaos@veigit.com>

…ntation

CatHood0 · 2025-03-12T01:32:02Z

If you're wondering why this PR suddenly has commits from other PRs, it was my mistake when trying to get the latest changes from master, using git pull instead of git merge.

lib/src/editor/raw_editor/input/ime/on_delete.dart

…roid

…k as expected

lib/src/editor/raw_editor/input/ime/on_non_update_text.dart

CatHood0 · 2025-03-12T06:27:15Z

lib/src/editor/raw_editor/input/formatters/text_editing_delta_formatters.dart

+// formatting method for the specific delta type (insertion, deletion, replacement, or non-text update).
+// If the delta type is not recognized, it throws an UnimplementedError.
+@internal
+@experimental


I need to improve the documentation of these extensions.

CatHood0 · 2025-03-12T06:27:51Z

example/pubspec.lock

      url: "https://pub.dev"
    source: hosted
-    version: "0.7.4"
+    version: "0.7.3"


Idk why this change was included, since i didn't change anything on the example.

…or web, since its buggy

CatHood0 · 2025-03-12T07:03:15Z

Important

I've been testing the change made in #2505, and it seems that when you press shift+arrow down in a Header block, it suddenly selects more text than it should (i'm gonna add a video later).

I can't say exactly why, but it seems like the change made in that PR needs to be tested, as it could impact the experience for users who aren't using any Chinese IME.

EchoEllet · 2025-03-12T13:44:28Z

example/pubspec.lock

      url: "https://pub.dev"
    source: hosted
-    version: "3.0.9"


Are you using the latest stable Flutter SDK?

EchoEllet · 2025-03-12T13:45:54Z

lib/src/editor/raw_editor/input/ime/on_replace_method.dart

+      }
+    }
+
+    if (Platform.isIOS) {


This wouldn't work on web, use isIOSApp or isIOS (which is true when on iOS even on a browser) instead.

EchoEllet · 2025-03-12T13:47:13Z

Idk exactly why, but, when i use web browsers, this exceptions are throwed:

That's because you're using dart:io on the web, which is not supported. We prefer not to import 'dart:io` at all or use conditional imports if necessary (which is error-prone) to get full score on pub.dev.

CatHood0 and others added 16 commits February 21, 2025 01:13

Chore: improved input client service

3297a1f

Chore: minor changes

b812460

Chore: renamed input client to the old name of the text input clinet

7685b57

Chore: removed unnecessary print

5a3dab3

Chore: moved internal editing extensions and change List deltas to a …

e039446

…single delta

Chore: removed unused import

bcacc27

doc: update controller length extension method deprecation message (s…

a4d567a

…ingerdmx#2483) * docs: update controller length extension method deprecation message * docs: update changelog

chore: update GitHub bug template to require the package version input

1a287b7

Focus and open context menu on right click if unfocused (singerdmx#2477)

54ccff3

Co-authored-by: CatHood0 <santiagowmar@gmail.com>

Expose Rule type so that Document.setCustomRules can be used (singerd…

dfb7bbc

…mx#2484)

feat: Enable BoxDecoration for DefaultTextBlockStyle of header Attrib…

eb91d24

…ute (singerdmx#2438) * feat: Enable BoxDecoration for DefaultTextBlockStyle of header Attribute --------- Co-authored-by: Ellet <echo.ellet@gmail.com>

fix: unpredictable endless loop of '_handleFocusChanged' in the phase…

8d63996

… of page route changing when editor is set to readonly. (singerdmx#2488) Co-authored-by: chaos <chaos@veigit.com>

chore(release): prepare to publish 11.1.0

62ecf21

Chore: added change to CHANGELOG

24e1305

Merge branch 'master' into improve_input_client

3a147cf

Chore: minor changes

9000119

CatHood0 added enhancement New feature or request in progress This issue or feature is currently being worked on by someone. labels Mar 12, 2025

CatHood0 self-assigned this Mar 12, 2025

CatHood0 marked this pull request as draft March 12, 2025 00:42

CatHood0 requested review from EchoEllet and singerdmx March 12, 2025 00:47

Chore: removed debounce timer since it does not needed in our impleme…

1518987

…ntation

This comment was marked as resolved.

Sign in to view

Chore: removed commented neccesary schedulers

50a1499

CatHood0 commented Mar 12, 2025

View reviewed changes

lib/src/editor/raw_editor/input/ime/on_delete.dart Show resolved Hide resolved

CatHood0 added 2 commits March 11, 2025 22:21

Chore: removed unnecessary _updateComposing method

d998e45

Fix: buggy behavior of the caret when try to delete characters on and…

6ceef54

…roid

This comment was marked as resolved.

Sign in to view

Chore: used old implementation for web since the new one does not wor…

fd66368

…k as expected

CatHood0 changed the title ~~Chore: improved support for soft-keyboards on the TextInputClient~~ Chore: improved the way we apply changes from TextInputClient Mar 12, 2025

CatHood0 commented Mar 12, 2025

View reviewed changes

lib/src/editor/raw_editor/input/ime/on_non_update_text.dart Show resolved Hide resolved

CatHood0 commented Mar 12, 2025

View reviewed changes

Chore: removed composing range validation to get the cursorPosition f…

e98e16d

…or web, since its buggy

EchoEllet reviewed Mar 12, 2025

View reviewed changes

example/pubspec.lock

url: "https://pub.dev"

source: hosted

version: "3.0.9"

Copy link

Collaborator

EchoEllet Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you using the latest stable Flutter SDK?

EchoEllet reviewed Mar 12, 2025

View reviewed changes

EchoEllet changed the title ~~Chore: improved the way we apply changes from TextInputClient~~ chore: improve changes application from TextInputClient Mar 12, 2025

Chore: replaced use of dart:io to use platform utils

9202560

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: improve changes application from TextInputClient #2510

chore: improve changes application from TextInputClient #2510

CatHood0 commented Mar 12, 2025 •

edited

Loading

This comment was marked as resolved.

CatHood0 commented Mar 12, 2025 •

edited

Loading

This comment was marked as resolved.

CatHood0 Mar 12, 2025

CatHood0 Mar 12, 2025

CatHood0 commented Mar 12, 2025 •

edited

Loading

EchoEllet Mar 12, 2025

EchoEllet Mar 12, 2025

EchoEllet commented Mar 12, 2025 •

edited

Loading

chore: improve changes application from TextInputClient #2510

Are you sure you want to change the base?

chore: improve changes application from TextInputClient #2510

Conversation

CatHood0 commented Mar 12, 2025 • edited Loading

Description

Related Issues

Type of Change

TODO

This comment was marked as resolved.

CatHood0 commented Mar 12, 2025 • edited Loading

This comment was marked as resolved.

CatHood0 Mar 12, 2025

Choose a reason for hiding this comment

CatHood0 Mar 12, 2025

Choose a reason for hiding this comment

CatHood0 commented Mar 12, 2025 • edited Loading

EchoEllet Mar 12, 2025

Choose a reason for hiding this comment

EchoEllet Mar 12, 2025

Choose a reason for hiding this comment

EchoEllet commented Mar 12, 2025 • edited Loading

CatHood0 commented Mar 12, 2025 •

edited

Loading

CatHood0 commented Mar 12, 2025 •

edited

Loading

CatHood0 commented Mar 12, 2025 •

edited

Loading

EchoEllet commented Mar 12, 2025 •

edited

Loading