useFocusScopeNode function

FocusScopeNode useFocusScopeNode({
  1. String? debugLabel,
  2. FocusOnKeyEventCallback? onKeyEvent,
  3. bool canRequestFocus = true,
  4. bool skipTraversal = false,
  5. bool descendantsAreFocusable = true,
})

A FocusScopeNode of the first build, for a FocusScope widget's node; each build sets what useFocusNode's does.

HookBuilder(
  builder: (context) {
    final scope = useFocusScopeNode(debugLabel: 'sidebar');
    return FocusScope(node: scope, child: TextField(autofocus: true));
  },
)

Implementation

FocusScopeNode useFocusScopeNode({
  String? debugLabel,
  FocusOnKeyEventCallback? onKeyEvent,
  bool canRequestFocus = true,
  bool skipTraversal = false,
  bool descendantsAreFocusable = true,
}) => use(
  _FocusNodeHook<FocusScopeNode>(
    FocusScopeNode.new,
    'useFocusScopeNode',
    nodeLabel: debugLabel,
    onKeyEvent: onKeyEvent,
    canRequestFocus: canRequestFocus,
    skipTraversal: skipTraversal,
    descendantsAreFocusable: descendantsAreFocusable,
  ),
);