StreamMessageTextField class - stream_chat_flutter library

Constructors

StreamMessageTextField({Key? key, StreamMessageInputController? controller, FocusNode? focusNode, InputDecoration? decoration = const InputDecoration(), TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, TextStyle? style, StrutStyle? strutStyle, TextAlign textAlign = TextAlign.start, TextAlignVertical? textAlignVertical, TextDirection? textDirection, bool readOnly = false, bool? showCursor, bool autofocus = false, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, int? maxLines, int? minLines, bool expands = false, int? maxLength, MaxLengthEnforcement? maxLengthEnforcement, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, List<TextInputFormatter>? inputFormatters, bool? enabled, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, Color? cursorColor, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20), DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? enableInteractiveSelection, TextSelectionControls? selectionControls, GestureTapCallback? onTap, MouseCursor? mouseCursor, InputCounterWidgetBuilder? buildCounter, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints = const <String>[], Clip clipBehavior = Clip.hardEdge, String? restorationId, bool scribbleEnabled = true, bool enableIMEPersonalizedLearning = true, ContentInsertionConfiguration? contentInsertionConfiguration}): Creates a Material Design text field.
const

Properties

autocorrect → bool: Whether to enable autocorrection.
final
autofillHints → Iterable<String>?: A list of strings that helps the autofill service identify the type of this text input.
final
autofocus → bool: Whether this text field should focus itself if nothing else is already focused.
final
buildCounter → InputCounterWidgetBuilder?: Callback that generates a custom InputDecoration.counter widget.
final
clipBehavior → Clip: The content will be clipped (or not) according to this option.
final
contentInsertionConfiguration → ContentInsertionConfiguration?: Configuration of handler for media content inserted via the system input method.
final
controller → StreamMessageInputController?: Controls the message being edited.
final
cursorColor → Color?: The color of the cursor.
final
cursorHeight → double?: How tall the cursor will be.
final
cursorRadius → Radius?: How rounded the corners of the cursor should be.
final
cursorWidth → double: How thick the cursor will be.
final
decoration → InputDecoration?: The decoration to show around the text field.
final
dragStartBehavior → DragStartBehavior: Determines the way that drag start behavior is handled.
final
enabled → bool?: If false the text field is "disabled": it ignores taps and its decoration is rendered in grey.
final
enableIMEPersonalizedLearning → bool: Whether to enable that the IME update personalized data such as typing history and user dictionary data.
final
enableInteractiveSelection → bool: Whether to enable user interface affordances for changing the text selection.
final
enableSuggestions → bool: Whether to show input suggestions as the user types.
final
expands → bool: Whether this widget's height will be sized to fill its parent.
final
focusNode → FocusNode?: Defines the keyboard focus for this widget.
final
hashCode → int: The hash code for this object.
no setterinherited
inputFormatters → List<TextInputFormatter>?: Optional input validation and formatting overrides.
final
key → Key?: Controls how one widget replaces another widget in the tree.
finalinherited
keyboardAppearance → Brightness?: The appearance of the keyboard.
final
keyboardType → TextInputType: The type of keyboard to use for editing the text.
final
maxLength → int?: The maximum number of characters (Unicode scalar values) to allow in the text field.
final
maxLengthEnforcement → MaxLengthEnforcement?: Determines how the maxLength limit should be enforced.
final
maxLines → int?: The maximum number of lines to show at one time, wrapping if necessary.
final
minLines → int?: The minimum number of lines to occupy when the content spans fewer lines.
final
mouseCursor → MouseCursor?: The cursor for a mouse pointer when it enters or is hovering over the widget.
final
obscureText → bool: Whether to hide the text being edited (e.g., for passwords).
final
obscuringCharacter → String: Character used for obscuring text if obscureText is true.
final
onAppPrivateCommand → AppPrivateCommandCallback?: This is used to receive a private command from the input method.
final
onChanged → ValueChanged<String>?: Called when the user initiates a change to the TextField's value: when they have inserted or deleted text.
final
onEditingComplete → VoidCallback?: Called when the user submits editable content (e.g., user presses the "done" button on the keyboard).
final
onSubmitted → ValueChanged<String>?: Called when the user indicates that they are done editing the text in the field.
final
onTap → GestureTapCallback?: Called for the first tap in a series of taps.
final
readOnly → bool: Whether the text can be changed.
final
restorationId → String?: Restoration ID to save and restore the state of the text field.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
scribbleEnabled → bool: Whether iOS 14 Scribble features are enabled for this widget.
final
scrollController → ScrollController?: The ScrollController to use when vertically scrolling the input.
final
scrollPadding → EdgeInsets: Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view.
final
scrollPhysics → ScrollPhysics?: The ScrollPhysics to use when vertically scrolling the input.
final
selectionControls → TextSelectionControls?: Optional delegate for building the text selection handles.
final
selectionEnabled → bool: Same as enableInteractiveSelection.
no setter
selectionHeightStyle → BoxHeightStyle: Controls how tall the selection highlight boxes are computed to be.
final
selectionWidthStyle → BoxWidthStyle: Controls how wide the selection highlight boxes are computed to be.
final
showCursor → bool?: Whether to show cursor.
final
smartDashesType → SmartDashesType: Whether to allow the platform to automatically format dashes.
final
smartQuotesType → SmartQuotesType: Whether to allow the platform to automatically format quotes.
final
strutStyle → StrutStyle?: The strut style used for the vertical layout.
final
style → TextStyle?: The style to use for the text being edited.
final
textAlign → TextAlign: How the text should be aligned horizontally.
final
textAlignVertical → TextAlignVertical?: How the text should be aligned vertically.
final
textCapitalization → TextCapitalization: Configures how the platform keyboard will select an uppercase or lowercase keyboard.
final
textDirection → TextDirection?: The directionality of the text.
final
textInputAction → TextInputAction?: The type of action button to use for the keyboard.
final

Methods

createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _StreamMessageTextFieldState: 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.
override
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}) → 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

Constants

noMaxLength → const int: If maxLength is set to this value, only the "current input length" part of the character counter is shown.