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.

See also:



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, 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) })
Creates a Material Design text field. [...]


autocorrect → bool
Whether to enable autocorrection. [...]
autofocus → bool
Whether this text field should focus itself if nothing else is already focused. [...]
controller TextEditingController
Controls the text being edited. [...]
cursorColor Color
The color to use when painting the cursor.
cursorRadius Radius
How rounded the corners of the cursor should be. By default, the cursor has a null Radius
cursorWidth → double
How thick the cursor will be. [...]
decoration InputDecoration
The decoration to show around the text field. [...]
enabled → bool
If false the textfield is "disabled": it ignores taps and its decoration is rendered in grey. [...]
focusNode FocusNode
Controls whether this widget has keyboard focus. [...]
inputFormatters → List<TextInputFormatter>
Optional input validation and formatting overrides. [...]
keyboardAppearance Brightness
The appearance of the keyboard. [...]
keyboardType TextInputType
The type of keyboard to use for editing the text. [...]
maxLength → int
The maximum number of characters (Unicode scalar values) to allow in the text field. [...]
maxLengthEnforced → bool
If true, prevents the field from allowing more than maxLength characters. [...]
maxLines → int
The maximum number of lines for the text to span, wrapping if necessary. [...]
obscureText → bool
Whether to hide the text being edited (e.g., for passwords). [...]
onChanged ValueChanged<String>
Called when the text being edited changes.
onEditingComplete VoidCallback
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard). [...]
onSubmitted ValueChanged<String>
Called when the user indicates that they are done editing the text in the field.
scrollPadding EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view. [...]
style TextStyle
The style to use for the text being edited. [...]
textAlign TextAlign
How the text being edited should be aligned horizontally. [...]
textCapitalization TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard. [...]
textInputAction TextInputAction
The type of action button to use for the keyboard. [...]
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


createState() → _TextFieldState
Creates the mutable state for this widget at a given location in the tree. [...]
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
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. [...]
toDiagnosticsNode({String name, DiagnosticsTreeStyle style }) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by toStringDeep. [...]
toString({DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this object.
toStringDeep({String prefixLineOne: '', String prefixOtherLines, DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a string representation of this node and its descendants. [...]
toStringShallow({String joiner: ', ', DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String
Returns a one-line detailed description of the object. [...]
toStringShort() → String
A short, textual description of this widget.


operator ==(dynamic other) → bool
The equality operator. [...]