Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack #159133

skimm3 · 2024-11-19T08:22:54Z

Fixes: #114213 and is a prerequisite for fixing: #148405

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Piinks · 2024-11-22T18:05:31Z

Adding @chunhtai for context on this resolving the go_router issue

Piinks

Hi @skimm3 welcome! Thanks for contributing. Is there a test that verifies this fixes the go_router issue you have linked as well?

chunhtai · 2024-11-22T18:11:22Z

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

-      return Visibility.maintain(
-        visible: i == index,
-        child: children[i],
+      return ExcludeFocus(


This feels something should be added to Visibility widget.

Also it seems it should not use Visibility.maintain since the maintain by default allows interactivity and semantics and animation unecessarily it should use

Visibility( visible: i == index, maintainSize: true, maintainState: true, child: children[i] )

Thanks for the feedback! Fixed the issue in Visibility widget instead. The new solution makes Visibility ignore focus when child is hidden for all combinations of maintain-parameters. I'm a bit unsure if it should be ignored when maintainInteractivity is true, what do you think?

Removed maintain interactivity and semantics from indexed stack and added a test. Could not remove maintainAnimation since that is needed if maintainSize is set.

It should ignore when maintainInteractivity is true since focus is part of interaction

skimm3 · 2024-11-24T10:22:53Z

Hi @skimm3 welcome! Thanks for contributing. Is there a test that verifies this fixes the go_router issue you have linked as well?

Thanks! I have a test that verifies the bug and that passes with my fix. Not sure what to do with it since the bug will be fixed when the user is using a flutter version containing this fix and not depending on a go_router version.

Here is the code for the test:

    testWidgets('Hidden children in a StatefulShellRoute can not receive focus', (WidgetTester tester) async {
      final GlobalKey<NavigatorState> rootNavigatorKey =
          GlobalKey<NavigatorState>();

      final List<RouteBase> routes = <RouteBase>[
        StatefulShellRoute.indexedStack(
          builder: (BuildContext context, GoRouterState state,
                  StatefulNavigationShell navigationShell) =>
              navigationShell,
          branches: <StatefulShellBranch>[
            StatefulShellBranch(routes: <GoRoute>[
              GoRoute(
                path: '/a',
                builder: (BuildContext context, GoRouterState state) =>
                    const Focus(child: Text('Screen A')),
              ),
            ]),
            StatefulShellBranch(routes: <GoRoute>[
              GoRoute(
                path: '/b',
                builder: (BuildContext context, GoRouterState state) =>
                    const Text('Screen B'),
              ),
            ]),
          ],
        ),
      ];

      final GoRouter router = await createRouter(routes, tester,
          initialLocation: '/a', navigatorKey: rootNavigatorKey);
      
      final Element screenA = tester.element(
        find.text('Screen A', skipOffstage: false),
      );
      final FocusNode screenAFocusNode = Focus.of(screenA);
      screenAFocusNode.requestFocus();
      await tester.pump();

      expect(screenAFocusNode.hasFocus, true);

      router.go('/b');
      await tester.pumpAndSettle();

      screenAFocusNode.requestFocus();
      await tester.pump();

      expect(screenAFocusNode.hasFocus, false);
    });

Piinks · 2024-11-25T16:44:27Z

Not sure what to do with it since the bug will be fixed when the user is using a flutter version containing this fix and not depending on a go_router version.

Hmm good question. @chunhtai do you think we should add this test to go_router after this lands to prevent regressions there?

chunhtai · 2024-11-25T17:56:33Z

I think we can create a simple test with indexed stack to make sure it hides focus of child underneath since this is the root cause of the go_router issue

packages/flutter/test/widgets/stack_test.dart

chunhtai

LGTM, thanks for fixing the issue!!

Piinks

LGTM too! 🎊 Thanks!

auto-submit · 2024-12-09T21:38:57Z

auto label is removed for flutter/flutter/159133, due to - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.

victorsanni · 2024-12-09T21:46:48Z

Currently taking a look at the google testing failures.

…, maintainFocusability. Set maintainFocusability to false in IndexedStack (flutter/flutter#159133)

Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (39 revisions) flutter/flutter@33cdd8e...85564cb 2025-05-23 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#169276)" (flutter/flutter#169347) 2025-05-23 [email protected] Roll Skia from a01ea49f53a4 to 956fd8b14e22 (1 revision) (flutter/flutter#169334) 2025-05-23 [email protected] Roll Dart SDK from 4de10a11ceb9 to 085f110ecf33 (1 revision) (flutter/flutter#169333) 2025-05-23 [email protected] Roll Skia from bcc7e7fce10e to a01ea49f53a4 (1 revision) (flutter/flutter#169329) 2025-05-23 [email protected] Roll Skia from 18b85aced9b7 to bcc7e7fce10e (3 revisions) (flutter/flutter#169323) 2025-05-23 [email protected] Roll Dart SDK from 2a45b2f88a4f to 4de10a11ceb9 (2 revisions) (flutter/flutter#169322) 2025-05-23 [email protected] Remove patching of `package_config.json` from Flutter Pub wrapper. (flutter/flutter#169306) 2025-05-23 [email protected] Add missing dart_dynamic_modules flag for iOS DDM simulator builds (flutter/flutter#169254) 2025-05-23 [email protected] Roll Skia from ea73ccdc1417 to 18b85aced9b7 (6 revisions) (flutter/flutter#169315) 2025-05-23 [email protected] Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack (flutter/flutter#159133) 2025-05-23 [email protected] [Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (flutter/flutter#169276) 2025-05-23 [email protected] Roll Dart SDK from 8f85d89fdc23 to 2a45b2f88a4f (6 revisions) (flutter/flutter#169312) 2025-05-23 [email protected] Removes unnecessary parentheses (flutter/flutter#169015) 2025-05-22 [email protected] Unpin test/test_core/test_api packages (flutter/flutter#169198) 2025-05-22 [email protected] [Engine] Fix an edge case of RoundSuperellipseParam::Contains with sharp corners (flutter/flutter#167977) 2025-05-22 [email protected] Replace goldens in test/cupertino/nav_bar_transition_test.dart (flutter/flutter#169172) 2025-05-22 [email protected] Roll Skia from 13a299964c9f to ea73ccdc1417 (35 revisions) (flutter/flutter#169303) 2025-05-22 [email protected] Increase sub-task timeout for Mac web_tool_tests (flutter/flutter#169307) 2025-05-22 [email protected] Fix crash on two finger selection gesture (flutter/flutter#168598) 2025-05-22 [email protected] Disable the ability to opt-out of `explicit-package-dependencies`. (flutter/flutter#169283) 2025-05-22 [email protected] Fixes tab semantics gets dropped if the child produce a semantics node (flutter/flutter#169233) 2025-05-22 [email protected] Skip `{PLAT}_web_tools_test#expression_evaluation_*_test.dart`, turning tree 🔴 (flutter/flutter#169305) 2025-05-22 [email protected] Update tool-internal `generateLocalizations...()` to never use synthetic (`flutter_gen`) packages (flutter/flutter#169285) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Make `build_android_host_app_with_module_aar` build using an aar (#169171)" (flutter/flutter#169287) 2025-05-22 [email protected] Increase sub-task timeout for `web_tool_tests_1_2` (flutter/flutter#169277) 2025-05-22 [email protected] refactor the usage of `MediaQuery.sizeOf(context).height` to use the new `.heightOf(context)` (flutter/flutter#168894) 2025-05-22 [email protected] [tool] Add --no-minify flag to JS Compiler (flutter/flutter#169102) 2025-05-22 [email protected] Update ButtonStyle documentation (flutter/flutter#168062) 2025-05-22 [email protected] Fix the issue where DropdownMenu disposes of the controller. (flutter/flutter#168541) 2025-05-22 [email protected] Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (#168914)" (flutter/flutter#169250) 2025-05-21 [email protected] Roll Dart SDK from 56940edd099d to 8f85d89fdc23 (6 revisions) (flutter/flutter#169237) 2025-05-21 [email protected] Use gestureSettings.touchSlop in PrimaryPointerGestureRecognizer (flutter/flutter#161549) 2025-05-21 [email protected] Normalize BottomAppBarTheme (continue) (flutter/flutter#168966) 2025-05-21 [email protected] [Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (flutter/flutter#168914) 2025-05-21 [email protected] Respect `calendarDelegate` in `showDateRangePicker` (flutter/flutter#168290) 2025-05-21 [email protected] Make `build_android_host_app_with_module_aar` build using an aar (flutter/flutter#169171) 2025-05-21 [email protected] Roll Dart SDK from 7c40eba6bf77 to 56940edd099d (flutter/flutter#169135) 2025-05-21 [email protected] Feat: Add full screen dialog support for dialog routes (flutter/flutter#167794) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. ...

…r#9315) Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (39 revisions) flutter/flutter@33cdd8e...85564cb 2025-05-23 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#169276)" (flutter/flutter#169347) 2025-05-23 [email protected] Roll Skia from a01ea49f53a4 to 956fd8b14e22 (1 revision) (flutter/flutter#169334) 2025-05-23 [email protected] Roll Dart SDK from 4de10a11ceb9 to 085f110ecf33 (1 revision) (flutter/flutter#169333) 2025-05-23 [email protected] Roll Skia from bcc7e7fce10e to a01ea49f53a4 (1 revision) (flutter/flutter#169329) 2025-05-23 [email protected] Roll Skia from 18b85aced9b7 to bcc7e7fce10e (3 revisions) (flutter/flutter#169323) 2025-05-23 [email protected] Roll Dart SDK from 2a45b2f88a4f to 4de10a11ceb9 (2 revisions) (flutter/flutter#169322) 2025-05-23 [email protected] Remove patching of `package_config.json` from Flutter Pub wrapper. (flutter/flutter#169306) 2025-05-23 [email protected] Add missing dart_dynamic_modules flag for iOS DDM simulator builds (flutter/flutter#169254) 2025-05-23 [email protected] Roll Skia from ea73ccdc1417 to 18b85aced9b7 (6 revisions) (flutter/flutter#169315) 2025-05-23 [email protected] Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack (flutter/flutter#159133) 2025-05-23 [email protected] [Reland2] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (flutter/flutter#169276) 2025-05-23 [email protected] Roll Dart SDK from 8f85d89fdc23 to 2a45b2f88a4f (6 revisions) (flutter/flutter#169312) 2025-05-23 [email protected] Removes unnecessary parentheses (flutter/flutter#169015) 2025-05-22 [email protected] Unpin test/test_core/test_api packages (flutter/flutter#169198) 2025-05-22 [email protected] [Engine] Fix an edge case of RoundSuperellipseParam::Contains with sharp corners (flutter/flutter#167977) 2025-05-22 [email protected] Replace goldens in test/cupertino/nav_bar_transition_test.dart (flutter/flutter#169172) 2025-05-22 [email protected] Roll Skia from 13a299964c9f to ea73ccdc1417 (35 revisions) (flutter/flutter#169303) 2025-05-22 [email protected] Increase sub-task timeout for Mac web_tool_tests (flutter/flutter#169307) 2025-05-22 [email protected] Fix crash on two finger selection gesture (flutter/flutter#168598) 2025-05-22 [email protected] Disable the ability to opt-out of `explicit-package-dependencies`. (flutter/flutter#169283) 2025-05-22 [email protected] Fixes tab semantics gets dropped if the child produce a semantics node (flutter/flutter#169233) 2025-05-22 [email protected] Skip `{PLAT}_web_tools_test#expression_evaluation_*_test.dart`, turning tree 🔴 (flutter/flutter#169305) 2025-05-22 [email protected] Update tool-internal `generateLocalizations...()` to never use synthetic (`flutter_gen`) packages (flutter/flutter#169285) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Make `build_android_host_app_with_module_aar` build using an aar (#169171)" (flutter/flutter#169287) 2025-05-22 [email protected] Increase sub-task timeout for `web_tool_tests_1_2` (flutter/flutter#169277) 2025-05-22 [email protected] refactor the usage of `MediaQuery.sizeOf(context).height` to use the new `.heightOf(context)` (flutter/flutter#168894) 2025-05-22 [email protected] [tool] Add --no-minify flag to JS Compiler (flutter/flutter#169102) 2025-05-22 [email protected] Update ButtonStyle documentation (flutter/flutter#168062) 2025-05-22 [email protected] Fix the issue where DropdownMenu disposes of the controller. (flutter/flutter#168541) 2025-05-22 [email protected] Add bottomSheetScrimBuilder to Scaffold (flutter/flutter#167335) 2025-05-22 98614782+auto-submit[bot]@users.noreply.github.com Reverts "[Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (#168914)" (flutter/flutter#169250) 2025-05-21 [email protected] Roll Dart SDK from 56940edd099d to 8f85d89fdc23 (6 revisions) (flutter/flutter#169237) 2025-05-21 [email protected] Use gestureSettings.touchSlop in PrimaryPointerGestureRecognizer (flutter/flutter#161549) 2025-05-21 [email protected] Normalize BottomAppBarTheme (continue) (flutter/flutter#168966) 2025-05-21 [email protected] [Reland] Implements UISceneDelegate dynamically w/ FlutterLaunchEngine (#168396) (flutter/flutter#168914) 2025-05-21 [email protected] Respect `calendarDelegate` in `showDateRangePicker` (flutter/flutter#168290) 2025-05-21 [email protected] Make `build_android_host_app_with_module_aar` build using an aar (flutter/flutter#169171) 2025-05-21 [email protected] Roll Dart SDK from 7c40eba6bf77 to 56940edd099d (flutter/flutter#169135) 2025-05-21 [email protected] Feat: Add full screen dialog support for dialog routes (flutter/flutter#167794) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. ...

…, maintainFocusability. Set maintainFocusability to false in IndexedStack (flutter/flutter#159133)

joachimbulow · 2025-09-11T09:44:20Z

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

    this.maintainSize = false,
    this.maintainSemantics = false,
    this.maintainInteractivity = false,
+    this.maintainFocusability = false,


Suggested change

this.maintainFocusability = false,

this.maintainFocusability = true,

Please do not introduce breaking changes like this
Projects that relied on maintainState for hidden focus widgets are broken now

Issue 174652

github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label Nov 19, 2024

Piinks self-requested a review November 19, 2024 23:28

victorsanni self-requested a review November 19, 2024 23:29

Piinks requested a review from chunhtai November 22, 2024 18:05

Piinks added f: routes Navigator, Router, and related APIs. f: focus Focus traversal, gaining or losing focus p: go_router The go_router package labels Nov 22, 2024

Piinks reviewed Nov 22, 2024

View reviewed changes

chunhtai reviewed Nov 22, 2024

View reviewed changes

skimm3 force-pushed the exclude-focus-for-hidden-children-in-indexed-stack branch from bc8c4fe to 025bee5 Compare November 24, 2024 10:04

github-actions bot removed f: routes Navigator, Router, and related APIs. f: focus Focus traversal, gaining or losing focus labels Nov 24, 2024

victorsanni reviewed Nov 25, 2024

View reviewed changes

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

skimm3 force-pushed the exclude-focus-for-hidden-children-in-indexed-stack branch 2 times, most recently from bfc5c95 to 651d851 Compare November 29, 2024 06:41

skimm3 requested a review from chunhtai November 29, 2024 06:48

skimm3 changed the title ~~Exclude focus for hidden children in an IndexedStack~~ Exclude focus for child when it is hidden in Visibility if maintainInteractivity is not set Nov 29, 2024

chunhtai approved these changes Dec 9, 2024

View reviewed changes

chunhtai requested review from Piinks and victorsanni December 9, 2024 19:59

victorsanni approved these changes Dec 9, 2024

View reviewed changes

Piinks approved these changes Dec 9, 2024

View reviewed changes

chunhtai added the autosubmit Merge PR when tree becomes green via auto submit App label Dec 9, 2024

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Dec 9, 2024

skimm3 added 5 commits May 22, 2025 16:44

format files

31fa90a

set maintainFocusability to false as default

ba84162

do not expose maintainFocusability on IndexedStack

6fd1698

resolve comments, format code

428c723

fix PR docs comments

dffd4e8

Renzo-Olivares force-pushed the exclude-focus-for-hidden-children-in-indexed-stack branch from b9752b3 to dffd4e8 Compare May 22, 2025 23:44

Renzo-Olivares added the autosubmit Merge PR when tree becomes green via auto submit App label May 22, 2025

auto-submit bot added this pull request to the merge queue May 23, 2025

Merged via the queue into flutter:master with commit a44675c May 23, 2025
75 of 76 checks passed

flutter-dashboard bot removed the autosubmit Merge PR when tree becomes green via auto submit App label May 23, 2025

github-project-automation bot moved this from In Progress to Done in Google Testing Queue May 23, 2025

engine-flutter-autoroll mentioned this pull request May 23, 2025

Roll Flutter from 33cdd8ef31dc to d5ae7839620b (38 revisions) flutter/packages#9314

Closed

engine-flutter-autoroll mentioned this pull request May 23, 2025

Roll Flutter from 33cdd8ef31dc to 85564cbba9e7 (39 revisions) flutter/packages#9315

Merged

Piinks mentioned this pull request May 23, 2025

Flutter Notable Commits - 2025 #161460

Open

chunhtai mentioned this pull request Jun 25, 2025

[A11y]: Keyboard Arrow Navigation not working for IndexedStack #170908

Closed

AFAS-HHO mentioned this pull request Aug 28, 2025

Breaking Change Missing maintainFocusability v3.35 #174652

Closed

joachimbulow reviewed Sep 11, 2025

View reviewed changes

flutter locked and limited conversation to collaborators Sep 15, 2025

Renzo-Olivares added the c: API break Backwards-incompatible API changes label Oct 2, 2025

	this.maintainFocusability = false,
	this.maintainFocusability = true,

Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack #159133

Add flag to exclude focus for hidden children in Visibility, maintainFocusability. Set maintainFocusability to false in IndexedStack #159133

Uh oh!

Conversation

skimm3 commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Piinks commented Nov 22, 2024

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

chunhtai Nov 22, 2024

Choose a reason for hiding this comment

Uh oh!

chunhtai Nov 22, 2024

Choose a reason for hiding this comment

Uh oh!

skimm3 Nov 24, 2024

Choose a reason for hiding this comment

Uh oh!

chunhtai Nov 25, 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!

skimm3 commented Nov 24, 2024

Uh oh!

Piinks commented Nov 25, 2024

Uh oh!

chunhtai commented Nov 25, 2024

Uh oh!

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

Piinks left a comment

Choose a reason for hiding this comment

Uh oh!

auto-submit bot commented Dec 9, 2024

Uh oh!

victorsanni commented Dec 9, 2024

Uh oh!

Uh oh!

joachimbulow Sep 11, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

skimm3 commented Nov 19, 2024 •

edited

Loading

chunhtai Nov 25, 2024 •

edited

Loading