JsKeyboardCapture class

Keyboard capture wrapper for jsr.onKey.

Hosts that render a JsonWidgetRenderer tree directly (instead of using JsWidgetRuntimeWidget) must wrap the rendered tree with this widget so jsr.onKey handlers receive key events:

JsKeyboardCapture(
  onEvent: (payload) => engine.dispatchHostEvent('key', payload),
  child: renderer.build(tree, context),
)

Behavior:

  • Claims keyboard focus on the first tap inside the subtree — embedded hosts (boards, panels) otherwise leave primary focus empty and keystrokes die before reaching the widget.
  • Yields to editable text: while a textField/textArea node (or any other EditableText) holds focus, key events are not intercepted.
Inheritance

Constructors

JsKeyboardCapture({Key? key, required void onEvent(Map<String, dynamic> payload), required Widget child})
const

Properties

child → Widget
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onEvent → void Function(Map<String, dynamic> payload)
Receives the JSON payload for every key event: {key, code, down, repeat}.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<JsKeyboardCapture>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited