useFocusNode function

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

A FocusNode of the first build, for a Focus widget's focusNode; each build sets its debugLabel, onKeyEvent, canRequestFocus, skipTraversal and descendantsAreFocusable.

A field that takes the focus when a key asks for it:

HookBuilder(
  builder: (context) {
    final node = useFocusNode(debugLabel: 'search');
    return KeyBindings({
      '/': node.requestFocus,
    }, child: TextField(focusNode: node));
  },
)

Implementation

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