Skip to content

feat: add descendantsAreTraversable parameter to useFocusNode #476

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Aug 12, 2025
Merged

feat: add descendantsAreTraversable parameter to useFocusNode #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/flutter_hooks/lib/src/focus_node.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ FocusNode useFocusNode({
bool skipTraversal = false,
bool canRequestFocus = true,
bool descendantsAreFocusable = true,
bool descendantsAreTraversable = true,
}) {
return use(
_FocusNodeHook(
Expand All @@ -18,6 +19,7 @@ FocusNode useFocusNode({
skipTraversal: skipTraversal,
canRequestFocus: canRequestFocus,
descendantsAreFocusable: descendantsAreFocusable,
descendantsAreTraversable: descendantsAreTraversable,
),
);
}
Expand All @@ -29,13 +31,15 @@ class _FocusNodeHook extends Hook<FocusNode> {
required this.skipTraversal,
required this.canRequestFocus,
required this.descendantsAreFocusable,
required this.descendantsAreTraversable,
});

final String? debugLabel;
final FocusOnKeyEventCallback? onKeyEvent;
final bool skipTraversal;
final bool canRequestFocus;
final bool descendantsAreFocusable;
final bool descendantsAreTraversable;

@override
_FocusNodeHookState createState() {
Expand All @@ -50,6 +54,7 @@ class _FocusNodeHookState extends HookState<FocusNode, _FocusNodeHook> {
skipTraversal: hook.skipTraversal,
canRequestFocus: hook.canRequestFocus,
descendantsAreFocusable: hook.descendantsAreFocusable,
descendantsAreTraversable: hook.descendantsAreTraversable,
);

@override
Expand All @@ -59,6 +64,7 @@ class _FocusNodeHookState extends HookState<FocusNode, _FocusNodeHook> {
..skipTraversal = hook.skipTraversal
..canRequestFocus = hook.canRequestFocus
..descendantsAreFocusable = hook.descendantsAreFocusable
..descendantsAreTraversable = hook.descendantsAreTraversable
..onKeyEvent = hook.onKeyEvent;
}

Expand Down
6 changes: 6 additions & 0 deletions packages/flutter_hooks/test/use_focus_node_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ void main() {
expect(focusNode.skipTraversal, official.skipTraversal);
expect(focusNode.canRequestFocus, official.canRequestFocus);
expect(focusNode.descendantsAreFocusable, official.descendantsAreFocusable);
expect(focusNode.descendantsAreTraversable,
official.descendantsAreTraversable);
});

testWidgets('has all the FocusNode parameters', (tester) async {
Expand All @@ -91,6 +93,7 @@ void main() {
skipTraversal: true,
canRequestFocus: false,
descendantsAreFocusable: false,
descendantsAreTraversable: false,
);
return Container();
}),
Expand All @@ -101,6 +104,7 @@ void main() {
expect(focusNode.skipTraversal, true);
expect(focusNode.canRequestFocus, false);
expect(focusNode.descendantsAreFocusable, false);
expect(focusNode.descendantsAreTraversable, false);
});

testWidgets('handles parameter change', (tester) async {
Expand All @@ -118,6 +122,7 @@ void main() {
skipTraversal: true,
canRequestFocus: false,
descendantsAreFocusable: false,
descendantsAreTraversable: false,
);

return Container();
Expand All @@ -140,5 +145,6 @@ void main() {
expect(focusNode.skipTraversal, false);
expect(focusNode.canRequestFocus, true);
expect(focusNode.descendantsAreFocusable, true);
expect(focusNode.descendantsAreTraversable, true);
});
}