ArnaTextField class

An Arna-styled text field.

A text field lets the user enter text, either with a hardware keyboard or with an onscreen keyboard.

The text field calls the onChanged callback whenever the user changes the text in the field. If the user indicates that they are done typing in the field (e.g., by pressing a button on the soft keyboard), the text field calls the onSubmitted callback.

To control the text that is displayed in the text field, use the controller. For example, to set the initial value of the text field, use a controller that already contains some text. The controller can also control the selection and composing region (and to observe changes to the text, selection, and composing region).

To integrate the ArnaTextField into a Form with other FormField widgets, consider using ArnaTextFormField.

When the widget has focus, it will prevent itself from disposing via its underlying EditableText's AutomaticKeepAliveClientMixin.wantKeepAlive in order to avoid losing the selection. Removing the focus will allow it to be disposed.

Remember to call TextEditingController.dispose of the TextEditingController when it is no longer needed. This will ensure we discard any resources used by the object.

{@tool snippet} This example shows how to create an ArnaTextField that will obscure input.

const ArnaTextField(
  obscureText: true,
)

{@end-tool}

Reading values

A common way to read a value from a TextField is to use the onSubmitted callback. This callback is applied to the text field's current value when the user finishes editing.

For most applications the onSubmitted callback will be sufficient for reacting to user input.

The onEditingComplete callback also runs when the user finishes editing. It's different from onSubmitted because it has a default value which updates the text controller and yields the keyboard focus. Applications that require different behavior can override the default onEditingComplete callback.

Keep in mind you can also always read the current string from a TextField's TextEditingController using TextEditingController.text.

Constructors

ArnaTextField({Key? key, TextEditingController? controller, FocusNode? focusNode, String? hintText, Widget? prefix, ArnaOverlayVisibilityMode prefixMode = ArnaOverlayVisibilityMode.always, Widget? suffix, ArnaOverlayVisibilityMode suffixMode = ArnaOverlayVisibilityMode.always, ArnaOverlayVisibilityMode clearButtonMode = ArnaOverlayVisibilityMode.never, TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization = TextCapitalization.none, StrutStyle? strutStyle, TextAlign textAlign = TextAlign.start, TextAlignVertical? textAlignVertical, TextDirection? textDirection, bool readOnly = false, ToolbarOptions? toolbarOptions, bool? showCursor, bool autofocus = false, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, int? maxLines = 1, 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 = Styles.cursorWidth, double? cursorHeight, Radius? cursorRadius = const Radius.circular(Styles.cursorRadius), Color? accentColor, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(Styles.padding), DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? enableInteractiveSelection, TextSelectionControls? selectionControls, GestureTapCallback? onTap, MouseCursor cursor = MouseCursor.defer, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints = const <String>[], String? restorationId, bool scribbleEnabled = true, bool enableIMEPersonalizedLearning = true}): Creates an Arna-styled text field.
const

Properties

accentColor → Color?: The color of the text field.
final
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
clearButtonMode → ArnaOverlayVisibilityMode: Show a clear button to clear the current text entry.
final
controller → TextEditingController?: Controls the text being edited.
final
cursor → MouseCursor: The cursor for a mouse pointer when it enters or is hovering over the text field.
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
dragStartBehavior → DragStartBehavior: Determines the way that drag start behavior is handled.
final
enabled → bool?: Disables the text field when false.
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
hintText → String?: A lighter colored hint that appears on the first line of the text field when the text entry is empty.
final
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 grapheme clusters) 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
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 each distinct tap except for every second tap of a double tap.
final
prefix → Widget?: An optional Widget to display before the text.
final
prefixMode → ArnaOverlayVisibilityMode: Controls the visibility of the prefix widget based on the state of text entry when the prefix argument is not null.
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
suffix → Widget?: An optional Widget to display after the text.
final
suffixMode → ArnaOverlayVisibilityMode: Controls the visibility of the suffix widget based on the state of text entry when the suffix argument is not null.
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
toolbarOptions → ToolbarOptions: Configuration of toolbar options.
final

Methods

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