StreamTextInput class

A text input styled for the Stream design system.

StreamTextInput provides a custom text input container with outline borders, optional leading/trailing widgets, and animated helper text.

The field supports both controlled (via controller) and uncontrolled (via initialValue) modes. At most one may be provided; if neither is given, an internal controller is created automatically.

Visual properties are resolved in order:

  1. Per-instance style overrides
  2. StreamTextInputTheme from the widget tree
  3. Design token fallbacks from StreamColorScheme and StreamTextTheme

{@tool snippet}

Basic text input with hint:

StreamTextInput(
  hintText: 'Enter your name',
  onChanged: (value) => print(value),
)

{@end-tool}

{@tool snippet}

Text input with error:

StreamTextInput(
  initialValue: 'bad input',
  helperText: 'This field is required',
  helperState: StreamHelperState.error,
  onChanged: (value) {},
)

{@end-tool}

{@tool snippet}

Controlled text input with leading icon:

StreamTextInput(
  controller: myController,
  leading: Icon(Icons.search),
  hintText: 'Search...',
)

{@end-tool}

See also:

Inheritance

Constructors

StreamTextInput({Key? key, TextEditingController? controller, String? initialValue, bool enabled = true, Widget? leading, Widget? trailing, String? hintText, String? helperText, StreamHelperState? helperState, StreamTextInputStyle? style, FocusNode? focusNode, TextInputType? keyboardType, TextInputAction? textInputAction, List<TextInputFormatter>? inputFormatters, bool autocorrect = false, bool autofocus = false, bool readOnly = false, TextAlign textAlign = .start, TextAlignVertical? textAlignVertical, int? maxLines = 1, int? minLines, int? maxLength, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, GestureTapCallback? onTap, TextCapitalization textCapitalization = .sentences})
Creates a Stream text input.

Properties

hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
props → StreamTextInputProps
The props controlling the appearance and behavior of this text input.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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