Add parentNode to FocusScope widget (flutter#114034)

gspencergoog · Oct 25, 2022 · 8c3806f · 8c3806f
1 parent 3ce88d3
commit 8c3806f
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 2 deletions.
diff --git a/packages/flutter/lib/src/widgets/focus_scope.dart b/packages/flutter/lib/src/widgets/focus_scope.dart
@@ -760,6 +760,7 @@ class FocusScope extends Focus {
   const FocusScope({
     super.key,
     FocusScopeNode? node,
+    super.parentNode,
     required super.child,
     super.autofocus,
     super.onFocusChange,
@@ -781,6 +782,7 @@ class FocusScope extends Focus {
     Key? key,
     required Widget child,
     required FocusScopeNode focusScopeNode,
+    FocusNode? parentNode,
     bool autofocus,
     ValueChanged<bool>? onFocusChange,
   })  = _FocusScopeWithExternalFocusNode;
@@ -809,13 +811,13 @@ class _FocusScopeWithExternalFocusNode extends FocusScope {
     super.key,
     required super.child,
     required FocusScopeNode focusScopeNode,
+    super.parentNode,
     super.autofocus,
     super.onFocusChange,
   }) : super(
     node: focusScopeNode,
   );
 
-
   @override
   bool get _usingExternalFocus => true;
   @override
@@ -846,7 +848,7 @@ class _FocusScopeState extends _FocusState {
 
   @override
   Widget build(BuildContext context) {
-    _focusAttachment!.reparent();
+    _focusAttachment!.reparent(parent: widget.parentNode);
     return Semantics(
       explicitChildNodes: true,
       child: _FocusMarker(

diff --git a/packages/flutter/test/widgets/focus_scope_test.dart b/packages/flutter/test/widgets/focus_scope_test.dart
@@ -532,6 +532,72 @@ void main() {
       expect(insertedNode.hasFocus, isFalse);
     });
 
+    testWidgets('Setting parentNode determines focus scope tree hierarchy.', (WidgetTester tester) async {
+      final FocusScopeNode topNode = FocusScopeNode(debugLabel: 'Top');
+      final FocusScopeNode parentNode = FocusScopeNode(debugLabel: 'Parent');
+      final FocusScopeNode childNode = FocusScopeNode(debugLabel: 'Child');
+      final FocusScopeNode insertedNode = FocusScopeNode(debugLabel: 'Inserted');
+
+      await tester.pumpWidget(
+        FocusScope.withExternalFocusNode(
+            focusScopeNode: topNode,
+            child: Column(
+              children: <Widget>[
+                FocusScope.withExternalFocusNode(
+                  focusScopeNode: parentNode,
+                  child: const SizedBox(),
+                ),
+                FocusScope.withExternalFocusNode(
+                  focusScopeNode: childNode,
+                  parentNode: parentNode,
+                  child: const Focus(
+                    autofocus: true,
+                    child: SizedBox(),
+                  ),
+                )
+              ],
+            ),
+          ),
+      );
+      await tester.pump();
+
+      expect(childNode.hasFocus, isTrue);
+      expect(parentNode.hasFocus, isTrue);
+      expect(topNode.hasFocus, isTrue);
+
+      // Check that inserting a Focus in between doesn't reparent the child.
+      await tester.pumpWidget(
+        FocusScope.withExternalFocusNode(
+            focusScopeNode: topNode,
+            child: Column(
+              children: <Widget>[
+                FocusScope.withExternalFocusNode(
+                  focusScopeNode: parentNode,
+                  child: const SizedBox(),
+                ),
+                FocusScope.withExternalFocusNode(
+                  focusScopeNode: insertedNode,
+                  child: FocusScope.withExternalFocusNode(
+                    focusScopeNode: childNode,
+                    parentNode: parentNode,
+                    child: const Focus(
+                    autofocus: true,
+                    child: SizedBox(),
+                  ),
+                  ),
+                )
+              ],
+            ),
+          ),
+      );
+      await tester.pump();
+
+      expect(childNode.hasFocus, isTrue);
+      expect(parentNode.hasFocus, isTrue);
+      expect(topNode.hasFocus, isTrue);
+      expect(insertedNode.hasFocus, isFalse);
+    });
+
     // Arguably, this isn't correct behavior, but it is what happens now.
     testWidgets("Removing focused widget doesn't move focus to next widget within FocusScope", (WidgetTester tester) async {
       final GlobalKey<TestFocusState> keyA = GlobalKey();