-
Notifications
You must be signed in to change notification settings - Fork 29.7k
Ensure disabling text fields' interactive selection disables shortcuts #171050
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.
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
Ensure disabling text fields' interactive selection disables shortcuts #171050
Conversation
9773677 to
c7555ee
Compare
justinmc
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Is your plan for web to use DoNothingAndStopPropagation?
| targetPlatform: defaultTargetPlatform, | ||
| ); | ||
|
|
||
| final ClipboardData? data = await Clipboard.getData('text/plain'); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You probably saw this, but here is where we set up the mock clipboard for these tests and put a default string on it before each test. No action needed here, just explaining in case you hadn't encountered that yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That method call trick is very nifty... ... ... but we should 110% replace that with a proper clipboard API on dart:ui 😅
For web, the HTML text field handles the shortcuts and notifies Flutter Web that the text or selection has changed. Flutter's shortcut system isn't involved there. Instead, my current plan is to instead intercept the HTML DOM events that is fired when you do cut/copy/paste shortcuts and drop them using |
flutter#171050) [`EditableText.enableInteractiveSelection`](https://api.flutter.dev/flutter/widgets/EditableText/enableInteractiveSelection.html) can be used to disable text selection and shortcuts in a text field. Previously, `EditableText` would disable the shortcut actions using [`Action.isEnabled`](https://api.flutter.dev/flutter/widgets/Action/isEnabled.html). As a result, the action would ignore the key event, and the key event would propagate. On some platforms, the key event would propagate to the native text view, causing weird behaviors like text getting copied. Now, the text field shortcuts stop propagation of the key event when `enableInteractiveSelection` is `false`. This ensures that the text field "consumes" the key events and prevents a parent of the text field or native views from receiving the key event. Partially addresses flutter#157611⚠️ Note: This does not fix the bug on Flutter Web as it handles text field shortcuts separately. This will be fixed in a separate pull request. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
flutter#171050) [`EditableText.enableInteractiveSelection`](https://api.flutter.dev/flutter/widgets/EditableText/enableInteractiveSelection.html) can be used to disable text selection and shortcuts in a text field. Previously, `EditableText` would disable the shortcut actions using [`Action.isEnabled`](https://api.flutter.dev/flutter/widgets/Action/isEnabled.html). As a result, the action would ignore the key event, and the key event would propagate. On some platforms, the key event would propagate to the native text view, causing weird behaviors like text getting copied. Now, the text field shortcuts stop propagation of the key event when `enableInteractiveSelection` is `false`. This ensures that the text field "consumes" the key events and prevents a parent of the text field or native views from receiving the key event. Partially addresses flutter#157611⚠️ Note: This does not fix the bug on Flutter Web as it handles text field shortcuts separately. This will be fixed in a separate pull request. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
EditableText.enableInteractiveSelectioncan be used to disable text selection and shortcuts in a text field.Previously,
EditableTextwould disable the shortcut actions usingAction.isEnabled. As a result, the action would ignore the key event, and the key event would propagate. On some platforms, the key event would propagate to the native text view, causing weird behaviors like text getting copied.Now, the text field shortcuts stop propagation of the key event when
enableInteractiveSelectionisfalse. This ensures that the text field "consumes" the key events and prevents a parent of the text field or native views from receiving the key event.Partially addresses #157611
Pre-launch Checklist
///).If you need help, consider asking for advice on the #hackers-new channel on Discord.