TextField class

A material design text field.

A text field lets the user enter text, either with 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).

By default, a text field has a decoration that draws a divider below the text field. You can use the decoration property to control the decoration, for example by adding a label or an icon. If you set the decoration property to null, the decoration will be removed entirely, including the extra padding introduced by the decoration to save space for the labels.

If decoration is non-null (which is the default), the text field requires one of its ancestors to be a Material widget. When the TextField is tapped an ink splash that paints on the material is triggered, see ThemeData.splashFactory.

To integrate the TextField into a Form with other FormField widgets, consider using TextFormField.

Constructors

TextField({Key key, TextEditingController controller, FocusNode focusNode, InputDecoration decoration: const InputDecoration(), TextInputType keyboardType, TextInputAction textInputAction, TextCapitalization textCapitalization: TextCapitalization.none, TextStyle style, TextAlign textAlign: TextAlign.start, TextDirection textDirection, bool autofocus: false, bool obscureText: false, bool autocorrect: true, int maxLines: 1, int maxLength, bool maxLengthEnforced: true, ValueChanged<String> onChanged, VoidCallback onEditingComplete, ValueChanged<String> onSubmitted, List<TextInputFormatter> inputFormatters, bool enabled, double cursorWidth: 2.0, Radius cursorRadius, Color cursorColor, Brightness keyboardAppearance, EdgeInsets scrollPadding: const EdgeInsets.all(20.0), bool enableInteractiveSelection: true, GestureTapCallback onTap }): Creates a Material Design text field. [...]
const

Properties

autocorrect → bool: Whether to enable autocorrection. [...]
final
autofocus → bool: Whether this text field should focus itself if nothing else is already focused. [...]
final
controller → TextEditingController: Controls the text being edited. [...]
final
cursorColor → Color: The color to use when painting the cursor. [...]
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
enabled → bool: If false the textfield is "disabled": it ignores taps and its decoration is rendered in grey. [...]
final
enableInteractiveSelection → bool: If true, then long-pressing this TextField will select text and show the cut/copy/paste menu, and tapping will move the text caret. [...]
final
focusNode → FocusNode: Defines the keyboard focus for this widget. [...]
final
inputFormatters → List<TextInputFormatter>: Optional input validation and formatting overrides. [...]
final
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
maxLengthEnforced → bool: If true, prevents the field from allowing more than maxLength characters. [...]
final
maxLines → int: The maximum number of lines for the text to span, wrapping if necessary. [...]
final
obscureText → bool: Whether to hide the text being edited (e.g., for passwords). [...]
final
onChanged → ValueChanged<String>: Called when the text being edited changes.
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 when the user taps on this textfield. [...]
final
scrollPadding → EdgeInsets: Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view. [...]
final
style → TextStyle: The style to use for the text being edited. [...]
final
textAlign → TextAlign: How the text should be aligned horizontally. [...]
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
hashCode → int: The hash code for this object. [...]
read-only, inherited
key → Key: Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType → Type: A representation of the runtime type of the object.
read-only, inherited

Methods

createState() → _TextFieldState: Creates the mutable state for this widget at a given location in the tree. [...]
override
debugFillProperties(DiagnosticPropertiesBuilder properties) → void: Add additional properties associated with the node. [...]
override
createElement() → StatefulElement: Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
debugDescribeChildren() → List<DiagnosticsNode>: Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a non-existent 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 toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String: Returns 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 ==(dynamic 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.
9007199254740992