TextEditingControllerBuilder<S, A> class

A stateful widget that manages a TextEditingController and FocusNode with two-way binding to a Store.

The controller's text is synchronized with the store's state via toText. User input dispatches actions via fromTextEditingAction. State changes from other sources update the controller text automatically.

Typically used via WithStore.textEditingController rather than directly.

TextEditingControllerBuilder<MyState, MyAction>(
  store: store,
  toText: (state) => state.searchQuery,
  fromTextEditingAction: (a) => MyAction.textEditing(a),
  builder: (controller, focusNode) => TextField(
    controller: controller,
    focusNode: focusNode,
  ),
);
Inheritance

Constructors

TextEditingControllerBuilder({Key? key, required Widget builder(TextEditingController, FocusNode), required String toText(S state), required A fromTextEditingAction(TextEditingAction action), required Store<S, A> store})
Creates a TextEditingControllerBuilder.
const

Properties

builder → Widget Function(TextEditingController, FocusNode)
Builder that receives the managed controller and focus node.
final
fromTextEditingAction → A Function(TextEditingAction action)
Maps TextEditingActions to the store's action type.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
store → Store<S, A>
The store to synchronize with.
final
toText → String Function(S state)
Extracts the text value from the store's state.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TextEditingControllerBuilder<S, A>>
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