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.

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

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.

Obscured Input

This example shows how to create a TextField that will obscure input. The InputDecoration surrounds the field in a border using OutlineInputBorder and adds a label.

To create a local project with this code sample, run:
flutter create --sample=material.TextField.1 mysample

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.

This sample shows how to get a value from a TextField via the onSubmitted callback.

To create a local project with this code sample, run:
flutter create --sample=material.TextField.2 mysample


Upon completion of editing, like pressing the "done" button on the keyboard, two actions take place:

1st: Editing is finalized. The default behavior of this step includes an invocation of onChanged. That default behavior can be overridden. See onEditingComplete for details.

2nd: onSubmitted is invoked with the user's input value.

onSubmitted can be used to manually move focus to another input widget when a user finishes with the currently focused input widget.

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

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.

Handling emojis and other complex characters

It's important to always use characters when dealing with user input text that may contain complex characters. This will ensure that extended grapheme clusters and surrogate pairs are treated as single characters, as they appear to the user.

For example, when finding the length of some user input, use string.characters.length. Do NOT use string.length or even string.runes.length. For the complex character "👨‍👩‍👦", this appears to the user as a single character, and string.characters.length intuitively returns 1. On the other hand, string.length returns 8, and string.runes.length returns 5!

In the live Dartpad example above, try typing the emoji 👨‍👩‍👦 into the field and submitting. Because the example code measures the length with value.characters.length, the emoji is correctly counted as a single character.

Keep the caret visible when focused

When focused, this widget will make attempts to keep the text area and its caret (even when showCursor is false) visible, on these occasions:

  • When the user focuses this text field and it is not readOnly.
  • When the user changes the selection of the text field, or changes the text when the text field is not readOnly.
  • When the virtual keyboard pops up.

Troubleshooting Common Accessibility Issues

Customizing User Input Accessibility Announcements

To customize user input accessibility announcements triggered by text changes, use SemanticsService.announce to make the desired accessibility announcement.

On iOS, the on-screen keyboard may announce the most recent input incorrectly when a TextInputFormatter inserts a thousands separator to a currency value text field. The following example demonstrates how to suppress the default accessibility announcements by always announcing the content of the text field as a US currency value (the \$ inserts a dollar sign, the $newText interpolates the newText variable):

onChanged: (String newText) {
  if (newText.isNotEmpty) {
    SemanticsService.announce('\$$newText', Directionality.of(context));

This sample shows how to style a text field to match a filled or outlined Material Design 3 text field.

To create a local project with this code sample, run:
flutter create --sample=material.TextField.3 mysample

Scrolling Considerations

If this TextField is not a descendant of Scaffold and is being used within a Scrollable or nested Scrollables, consider placing a ScrollNotificationObserver above the root Scrollable that contains this TextField to ensure proper scroll coordination for TextField and its components like TextSelectionOverlay.

See also:



TextField({Key? key, TextEditingController? controller, FocusNode? focusNode, UndoHistoryController? undoController, 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, @Deprecated('Use `contextMenuBuilder` instead. ' 'This feature was deprecated after v3.3.0-0.5.pre.') ToolbarOptions? toolbarOptions, bool? showCursor, bool autofocus = false, MaterialStatesController? statesController, 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, bool? ignorePointers, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, bool? cursorOpacityAnimates, Color? cursorColor, Color? cursorErrorColor, BoxHeightStyle selectionHeightStyle = ui.BoxHeightStyle.tight, BoxWidthStyle selectionWidthStyle = ui.BoxWidthStyle.tight, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), DragStartBehavior dragStartBehavior = DragStartBehavior.start, bool? enableInteractiveSelection, TextSelectionControls? selectionControls, GestureTapCallback? onTap, bool onTapAlwaysCalled = false, TapRegionCallback? onTapOutside, MouseCursor? mouseCursor, InputCounterWidgetBuilder? buildCounter, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints = const <String>[], ContentInsertionConfiguration? contentInsertionConfiguration, Clip clipBehavior = Clip.hardEdge, String? restorationId, bool scribbleEnabled = true, bool enableIMEPersonalizedLearning = true, EditableTextContextMenuBuilder? contextMenuBuilder = _defaultContextMenuBuilder, bool canRequestFocus = true, SpellCheckConfiguration? spellCheckConfiguration, TextMagnifierConfiguration? magnifierConfiguration})
Creates a Material Design text field.


autocorrect bool
Whether to enable autocorrection.
autofillHints Iterable<String>?
A list of strings that helps the autofill service identify the type of this text input.
autofocus bool
Whether this text field should focus itself if nothing else is already focused.
buildCounter InputCounterWidgetBuilder?
Callback that generates a custom InputDecoration.counter widget.
canRequestFocus bool
Determine whether this text field can request the primary focus.
clipBehavior Clip
The content will be clipped (or not) according to this option.
contentInsertionConfiguration ContentInsertionConfiguration?
Configuration of handler for media content inserted via the system input method.
contextMenuBuilder EditableTextContextMenuBuilder?
Builds the text selection toolbar when requested by the user.
controller TextEditingController?
Controls the text being edited.
cursorColor Color?
The color of the cursor.
cursorErrorColor Color?
The color of the cursor when the InputDecorator is showing an error.
cursorHeight double?
How tall the cursor will be.
cursorOpacityAnimates bool?
Whether the cursor will animate from fully transparent to fully opaque during each cursor blink.
cursorRadius Radius?
How rounded the corners of the cursor should be.
cursorWidth double
How thick the cursor will be.
decoration InputDecoration?
The decoration to show around the text field.
dragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled.
enabled bool?
If false the text field is "disabled": it ignores taps and its decoration is rendered in grey.
enableIMEPersonalizedLearning bool
Whether to enable that the IME update personalized data such as typing history and user dictionary data.
enableInteractiveSelection bool
Whether to enable user interface affordances for changing the text selection.
enableSuggestions bool
Whether to show input suggestions as the user types.
expands bool
Whether this widget's height will be sized to fill its parent.
focusNode FocusNode?
Defines the keyboard focus for this widget.
hashCode int
The hash code for this object.
no setterinherited
ignorePointers bool?
Determines whether this widget ignores pointer events.
inputFormatters List<TextInputFormatter>?
Optional input validation and formatting overrides.
key Key?
Controls how one widget replaces another widget in the tree.
keyboardAppearance Brightness?
The appearance of the keyboard.
keyboardType TextInputType
The type of keyboard to use for editing the text.
magnifierConfiguration TextMagnifierConfiguration?
The configuration for the magnifier of this text field.
maxLength int?
The maximum number of characters (Unicode grapheme clusters) to allow in the text field.
maxLengthEnforcement MaxLengthEnforcement?
Determines how the maxLength limit should be enforced.
maxLines int?
The maximum number of lines to show at one time, wrapping if necessary.
minLines int?
The minimum number of lines to occupy when the content spans fewer lines.
mouseCursor MouseCursor?
The cursor for a mouse pointer when it enters or is hovering over the widget.
obscureText bool
Whether to hide the text being edited (e.g., for passwords).
obscuringCharacter String
Character used for obscuring text if obscureText is true.
onAppPrivateCommand AppPrivateCommandCallback?
This is used to receive a private command from the input method.
onChanged ValueChanged<String>?
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text.
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.
onTap GestureTapCallback?
Called for the first tap in a series of taps.
onTapAlwaysCalled bool
Whether onTap should be called for every tap.
onTapOutside TapRegionCallback?
Called for each tap that occurs outside of theTextFieldTapRegion group when the text field is focused.
readOnly bool
Whether the text can be changed.
restorationId String?
Restoration ID to save and restore the state of the text field.
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.
scrollController ScrollController?
The ScrollController to use when vertically scrolling the input.
scrollPadding EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view.
scrollPhysics ScrollPhysics?
The ScrollPhysics to use when vertically scrolling the input.
selectionControls TextSelectionControls?
Optional delegate for building the text selection handles.
selectionEnabled bool
Same as enableInteractiveSelection.
no setter
selectionHeightStyle BoxHeightStyle
Controls how tall the selection highlight boxes are computed to be.
selectionWidthStyle BoxWidthStyle
Controls how wide the selection highlight boxes are computed to be.
showCursor bool?
Whether to show cursor.
smartDashesType SmartDashesType
Whether to allow the platform to automatically format dashes.
smartQuotesType SmartQuotesType
Whether to allow the platform to automatically format quotes.
spellCheckConfiguration SpellCheckConfiguration?
Configuration that details how spell check should be performed.
statesController MaterialStatesController?
Represents the interactive "state" of this widget in terms of a set of MaterialStates, including MaterialState.disabled, MaterialState.hovered, MaterialState.error, and MaterialState.focused.
strutStyle StrutStyle?
The strut style used for the vertical layout.
style TextStyle?
The style to use for the text being edited.
textAlign TextAlign
How the text should be aligned horizontally.
textAlignVertical TextAlignVertical?
How the text should be aligned vertically.
textCapitalization TextCapitalization
Configures how the platform keyboard will select an uppercase or lowercase keyboard.
textDirection TextDirection?
The directionality of the text.
textInputAction TextInputAction?
The type of action button to use for the keyboard.
toolbarOptions ToolbarOptions?
Configuration of toolbar options.
undoController UndoHistoryController?
Controls the undo state.


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
createState() State<TextField>
Creates the mutable state for this widget at a given location in the tree.
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent 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 DiagnosticsNode.toStringDeep.
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
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 ==(Object other) bool
The equality operator.

Static Methods

defaultSpellCheckSuggestionsToolbarBuilder(BuildContext context, EditableTextState editableTextState) Widget
Default builder for TextField's spell check suggestions toolbar.
inferAndroidSpellCheckConfiguration(SpellCheckConfiguration? configuration) SpellCheckConfiguration
Returns a new SpellCheckConfiguration where the given configuration has had any missing values replaced with their defaults for the Android platform.


materialMisspelledTextStyle → const TextStyle
The TextStyle used to indicate misspelled words in the Material style.
noMaxLength → const int
If maxLength is set to this value, only the "current input length" part of the character counter is shown.