Adds a call to the `PlatformDispatcher` whenever the focus changes #151268

gspencergoog · 2024-07-03T21:10:34Z

Description

This adds a call to the PlatformDispatcher whenever the focus changes, so that the engine can decide what to do about view focus. This lets widgets use autofocus, and when they are focused their view will also receive focus.

Related Issues

Fixes The framework should track which view has focus and notify changes to the engine #151251

Tests

Added a test and some methods to the TestPlatformDispatcher to allow introspection of the values sent.

packages/flutter/lib/src/widgets/focus_manager.dart

tugorez · 2024-07-03T21:17:56Z

packages/flutter/lib/src/widgets/focus_manager.dart

    if (previousFocus != _primaryFocus) {
+      if (_primaryFocus != null && (_primaryFocus!.context?.mounted ?? false)) {
+        final int? viewId = View.maybeOf(_primaryFocus!.context!)?.viewId;
+        if (viewId != null) {


If viewId is null then we need to let the engine know that the previously focused view (that's what the latest focused view bit is for) lost focus, hence it should be blurred. See https://github.com/flutter/engine/blob/main/lib/web_ui/lib/src/engine/platform_dispatcher/view_focus_binding.dart#L57

If the view id is null, then this widget isn't in a view anymore, and shouldn't be receiving focus, much less notifying the engine of its focus change. This state (the view being null) should probably never happen, since anything that is no longer part of a view should be disposed before it gets here, and thus never have a chance to become the primary focus. The only node in the focus tree that this might legitimately happen to is the root node, which doesn't have a context and so would also not report.

We could keep track of what the view used to be the last time any node reported a focus change, but then why not just use the one kept in the engine, since the engine is controlling which view is focused anyhow?

gspencergoog · 2024-07-09T01:36:41Z

Okay @tugorez, this now does what you described. I still have to write a test for it, but take a look.

tugorez · 2024-07-09T01:50:18Z

packages/flutter/lib/src/widgets/focus_manager.dart

    _dirtyNodes.clear();
    if (previousFocus != _primaryFocus) {
+      if (_primaryFocus != null && (_primaryFocus!.context?.mounted ?? false)) {
+        final int? viewId = View.maybeOf(_primaryFocus!.context!)?.viewId;


IMO _lastFocusedViewId should be updated here, not by using the engine events. This is because we have two distinct concepts of "focus":

Flutter Focus: Managed by the framework, this represents the focus state within the Flutter widget tree.

Platform Focus: Managed by the platform (iOS, Android, Web), this represents the actual focus state of the "native" views.

These two can diverge, but we reconcile them using the view focus methods in the platform dispatcher. Updating _lastFocusedViewId here aligns with the idea that we're working with the Flutter focus concept.

tugorez · 2024-07-09T01:50:42Z

This LGTM. Thanks Greg :)!

gspencergoog · 2024-07-25T00:00:05Z

@tugorez I had to abandon the previous method of doing this because it was trying to look up deactivated elements in between frames. Instead, I'm doing all of the work in the View widget, since it already has to listen to view focus changes it can keep track of which view has focus and decide to notify the engine based on the focus of its focus scope node.

Please take another look. Thanks!

packages/flutter/lib/src/widgets/view.dart

packages/flutter/test/widgets/view_test.dart

…g observer

packages/flutter/test/widgets/view_test.dart

…st one.

…anges (flutter/flutter#151268)

Roll Flutter from 7d5c1c0 to 031dc3d (97 revisions) flutter/flutter@7d5c1c0...031dc3d 2024-07-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 342a42547822 to 354abf2800a0 (7 revisions) (flutter/flutter#152385) 2024-07-26 ryjohn@google.com Use more CORS headers for flutter run server (flutter/flutter#152249) 2024-07-26 engine-flutter-autoroll@skia.org Manual roll Flutter Engine from 8714b54a87c0 to 342a42547822 (6 revisions) (flutter/flutter#152379) 2024-07-26 34465683+rkishan516@users.noreply.github.com feat: Add drag handle size to be configurable based on given size (flutter/flutter#152085) 2024-07-26 matanlurey@users.noreply.github.com Add and use an integration test with native(ADB) screenshots (flutter/flutter#152326) 2024-07-26 engine-flutter-autoroll@skia.org Roll Packages from 19daf6f to 3d358d9 (4 revisions) (flutter/flutter#152372) 2024-07-26 32538273+ValentinVignal@users.noreply.github.com Add test for range_slider.0.dart (flutter/flutter#152152) 2024-07-26 tessertaha@gmail.com Introduce `TabBar.indicatorAnimation` to customize tab indicator animation (flutter/flutter#151746) 2024-07-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 21629ece8b72 to 8714b54a87c0 (3 revisions) (flutter/flutter#152351) 2024-07-26 kevmoo@users.noreply.github.com Cleanup examples/api web load logic to latest (flutter/flutter#152349) 2024-07-26 gspencergoog@users.noreply.github.com Adds a call to the `PlatformDispatcher` whenever the focus changes (flutter/flutter#151268) 2024-07-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from d665bf82dc32 to 21629ece8b72 (4 revisions) (flutter/flutter#152344) 2024-07-25 31859944+LongCatIsLooong@users.noreply.github.com `docImport`s for the widgets library (flutter/flutter#152339) 2024-07-25 jacksongardner@google.com Set dart defines properly while in debug mode. (flutter/flutter#152262) 2024-07-25 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 3.25.13 to 3.25.14 (flutter/flutter#152342) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 74785a771ae6 to d665bf82dc32 (2 revisions) (flutter/flutter#152340) 2024-07-25 leroux_bruno@yahoo.fr Cleanup InputDecoration.collapsed constructor (flutter/flutter#152165) 2024-07-25 32538273+ValentinVignal@users.noreply.github.com Add test for expansion_panel_list.expansion_panel_list_radio.0_test.dart (flutter/flutter#151730) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from f862a620cee4 to 74785a771ae6 (2 revisions) (flutter/flutter#152333) 2024-07-25 engine-flutter-autoroll@skia.org Roll Packages from 1c319ac to 19daf6f (3 revisions) (flutter/flutter#152327) 2024-07-25 31859944+LongCatIsLooong@users.noreply.github.com Add a more typical / concrete example to IntrinsicHeight / IntrinsicWidth (flutter/flutter#152246) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from f47b4d8e145a to f862a620cee4 (1 revision) (flutter/flutter#152320) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 74737820a8ee to f47b4d8e145a (7 revisions) (flutter/flutter#152314) 2024-07-25 42016383+DBowen33@users.noreply.github.com Flutter Web App: adds a11y semantic attributes to slider (flutter/flutter#151985) 2024-07-25 engine-flutter-autoroll@skia.org Manual roll Flutter Engine from eb8fac2b1703 to 74737820a8ee (8 revisions) (flutter/flutter#152305) 2024-07-25 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from eb8fac2b1703 to a57655cccb55 (6 revisions) (#152293)" (flutter/flutter#152304) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from eb8fac2b1703 to a57655cccb55 (6 revisions) (flutter/flutter#152293) 2024-07-25 biggs0125@gmail.com Modify stepping integration test to accommodate new DDC async semantics. (flutter/flutter#152204) 2024-07-25 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Roll Flutter Engine from eb8fac2b1703 to e1259b86ba02 (2 revisions) (#152285)" (flutter/flutter#152289) 2024-07-25 biggs0125@gmail.com Update fake_codec.dart to use Future.value instead of SynchronousFuture (flutter/flutter#152182) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from eb8fac2b1703 to e1259b86ba02 (2 revisions) (flutter/flutter#152285) 2024-07-25 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4b952093cb99 to eb8fac2b1703 (3 revisions) (flutter/flutter#152278) 2024-07-24 dkwingsmt@users.noreply.github.com [CupertinoAlertDialog] Rewrite (flutter/flutter#150410) 2024-07-24 victorsanniay@gmail.com Revert "Make `CupertinoRadio`'s `mouseCursor` a `WidgetStateProperty`" (flutter/flutter#152254) 2024-07-24 rmolivares@renzo-olivares.dev Fix: A selectable's selection under the active selection should not be cleared on right-click (flutter/flutter#151851) 2024-07-24 fluttergithubbot@gmail.com Marks Mac channels_integration_test to be flaky (flutter/flutter#151882) 2024-07-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from c2f489d783d6 to 4b952093cb99 (3 revisions) (flutter/flutter#152264) 2024-07-24 42016383+DBowen33@users.noreply.github.com added Semantics label to TextField with InputDecoration to let user kâ�¦ (flutter/flutter#151996) 2024-07-24 jasonkang14@gmail.com feat: Add alignmentOffset to DropdownMenu (flutter/flutter#151731) 2024-07-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from 490576daf810 to c2f489d783d6 (6 revisions) (flutter/flutter#152260) 2024-07-24 matanlurey@users.noreply.github.com Scaffolding for `NativeDriver` and `AndroidNativeDriver` for taking screenshots using `adb`. (flutter/flutter#152194) 2024-07-24 31859944+LongCatIsLooong@users.noreply.github.com `widgets` docImport (flutter/flutter#152146) 2024-07-24 engine-flutter-autoroll@skia.org Roll Flutter Engine from 3078f6a90e71 to 490576daf810 (1 revision) (flutter/flutter#152239) 2024-07-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Use more CORS headers for `flutter run` server (#152048)" (flutter/flutter#152248) 2024-07-24 ryjohn@google.com Use more CORS headers for `flutter run` server (flutter/flutter#152048) 2024-07-24 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Enable Swift Package Manager by default on master channel (#152049)" (flutter/flutter#152243) ...

…lutter#151268) ## Description This adds a call to the `PlatformDispatcher` whenever the focus changes, so that the engine can decide what to do about view focus. This lets widgets use autofocus, and when they are focused their view will also receive focus. ## Related Issues - Fixes flutter#151251 ## Tests - Added a test and some methods to the `TestPlatformDispatcher` to allow introspection of the values sent.

gspencergoog requested a review from tugorez July 3, 2024 21:10

github-actions bot added a: tests "flutter test", flutter_test, or one of our tests framework flutter/packages/flutter repository. See also f: labels. f: focus Focus traversal, gaining or losing focus labels Jul 3, 2024

tugorez reviewed Jul 3, 2024

View reviewed changes

packages/flutter/lib/src/widgets/focus_manager.dart Outdated Show resolved Hide resolved

tugorez reviewed Jul 3, 2024

View reviewed changes

gspencergoog force-pushed the view_focus_to_engine branch from 1bcc7d0 to caf4fc4 Compare July 9, 2024 01:33

gspencergoog mentioned this pull request Jul 9, 2024

Add PlatformDispatcher.focusedViewId and FlutterView.hasFocus. flutter/engine#53723

Closed

gspencergoog force-pushed the view_focus_to_engine branch from caf4fc4 to fdada0e Compare July 9, 2024 01:39

tugorez reviewed Jul 9, 2024

View reviewed changes

tugorez approved these changes Jul 9, 2024

View reviewed changes

gspencergoog force-pushed the view_focus_to_engine branch 2 times, most recently from 5c8f753 to 1348f58 Compare July 24, 2024 16:39

tugorez requested a review from goderbauer July 24, 2024 16:55

github-actions bot added the f: material design flutter/packages/flutter/material repository. label Jul 24, 2024

gspencergoog force-pushed the view_focus_to_engine branch from ec67d97 to 7e43fd7 Compare July 25, 2024 00:03

github-actions bot removed the f: material design flutter/packages/flutter/material repository. label Jul 25, 2024

gspencergoog force-pushed the view_focus_to_engine branch 3 times, most recently from 044efe0 to c9d65f6 Compare July 25, 2024 00:28

tugorez reviewed Jul 25, 2024

View reviewed changes

packages/flutter/lib/src/widgets/view.dart Show resolved Hide resolved

tugorez reviewed Jul 25, 2024

View reviewed changes

packages/flutter/test/widgets/view_test.dart Show resolved Hide resolved

gspencergoog added 5 commits July 25, 2024 11:17

Add call to engine when focus changes

e669dcc

Add listener for view focus changes to FocusManager

41cdb66

Remove unecessary logic around creating FocusManager's widgets bindin…

0054f60

…g observer

checkpoint

a448bb9

Convert to using post frame callback for focus resolution

16280de

gspencergoog added 2 commits July 25, 2024 11:17

Move logic to View widget

a2cb358

Change how views are unfocused in tests

0da68fa

gspencergoog force-pushed the view_focus_to_engine branch 2 times, most recently from 431d094 to ec3a0ef Compare July 25, 2024 18:49

Add a test, only notify on focus, not unfocus.

bed133b

gspencergoog force-pushed the view_focus_to_engine branch from ec3a0ef to bed133b Compare July 25, 2024 21:57

tugorez reviewed Jul 25, 2024

View reviewed changes

packages/flutter/test/widgets/view_test.dart Outdated Show resolved Hide resolved

Make focus events testing values record all events instead of just la…

ae21cab

…st one.

gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Jul 25, 2024

auto-submit bot merged commit 0f16a0e into flutter:master Jul 26, 2024

engine-flutter-autoroll mentioned this pull request Jul 26, 2024

Roll Flutter from 7d5c1c04fb56 to ccd51a7f5880 (91 revisions) flutter/packages#7222

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

920dd91

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 26, 2024

Roll Flutter from 7d5c1c04fb56 to 7f8ad8a4cb1b (93 revisions) flutter/packages#7223

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

a46c505

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 26, 2024

Roll Flutter from 7d5c1c04fb56 to 80cc52d7d1f6 (95 revisions) flutter/packages#7224

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

f0c2641

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 26, 2024

Roll Flutter from 7d5c1c04fb56 to 031dc3d156b9 (97 revisions) flutter/packages#7225

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 26, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

bbc3d67

…anges (flutter/flutter#151268)

Piinks mentioned this pull request Jul 26, 2024

Flutter Framework Team: Notable Commits #121415

Closed

engine-flutter-autoroll mentioned this pull request Jul 27, 2024

Roll Flutter from 7d5c1c04fb56 to e8d4c98b07f8 (115 revisions) flutter/packages#7227

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 27, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

0c11936

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 27, 2024

Roll Flutter from 7d5c1c04fb56 to f817e51a3a34 (116 revisions) flutter/packages#7228

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 27, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

955d0df

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 28, 2024

Roll Flutter from 7d5c1c04fb56 to 5efbde1a18ad (119 revisions) flutter/packages#7230

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 28, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

91bdfb4

…anges (flutter/flutter#151268)

engine-flutter-autoroll mentioned this pull request Jul 28, 2024

Roll Flutter from 7d5c1c04fb56 to 5efbde1a18ad (119 revisions) flutter/packages#7231

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Jul 28, 2024

0f16a0e Adds a call to the PlatformDispatcher whenever the focus ch…

c05404c

…anges (flutter/flutter#151268)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adds a call to the `PlatformDispatcher` whenever the focus changes #151268

Adds a call to the `PlatformDispatcher` whenever the focus changes #151268

Uh oh!

gspencergoog commented Jul 3, 2024

Uh oh!

Uh oh!

tugorez Jul 3, 2024

Uh oh!

gspencergoog Jul 3, 2024 •

edited

Loading

Uh oh!

gspencergoog commented Jul 9, 2024

Uh oh!

tugorez Jul 9, 2024

Uh oh!

tugorez commented Jul 9, 2024

Uh oh!

gspencergoog commented Jul 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Adds a call to the PlatformDispatcher whenever the focus changes #151268

Adds a call to the PlatformDispatcher whenever the focus changes #151268

Uh oh!

Conversation

gspencergoog commented Jul 3, 2024

Description

Related Issues

Tests

Uh oh!

Uh oh!

tugorez Jul 3, 2024

Choose a reason for hiding this comment

Uh oh!

gspencergoog Jul 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gspencergoog commented Jul 9, 2024

Uh oh!

tugorez Jul 9, 2024

Choose a reason for hiding this comment

Uh oh!

tugorez commented Jul 9, 2024

Uh oh!

gspencergoog commented Jul 25, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Adds a call to the `PlatformDispatcher` whenever the focus changes #151268

Adds a call to the `PlatformDispatcher` whenever the focus changes #151268

gspencergoog Jul 3, 2024 •

edited

Loading