EditableText class

A basic text input field.

This widget interacts with the TextInput service to let the user edit the text it contains. It also provides scrolling, selection, and cursor movement. This widget does not provide any focus management (e.g., tap-to-focus).

Input Actions

A TextInputAction can be provided to customize the appearance of the action button on the soft keyboard for Android and iOS. The default action is TextInputAction.done.

Many TextInputActions are common between Android and iOS. However, if an inputAction is provided that is not supported by the current platform in debug mode, an error will be thrown when the corresponding EditableText receives focus. For example, providing iOS's "emergencyCall" action when running on an Android device will result in an error when in debug mode. In release mode, incompatible TextInputActions are replaced either with "unspecified" on Android, or "default" on iOS. Appropriate inputActions can be chosen by checking the current platform and then selecting the appropriate action.


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.

Rather than using this widget directly, consider using TextField, which is a full-featured, material-design text input field with placeholder text, labels, and Form integration.

See also:

  • TextField, which is a full-featured, material-design text input field with placeholder text, labels, and Form integration.


EditableText({Key key, @required TextEditingController controller, @required FocusNode focusNode, bool obscureText: false, bool autocorrect: true, @required TextStyle style, @required Color cursorColor, TextAlign textAlign: TextAlign.start, TextDirection textDirection, Locale locale, double textScaleFactor, int maxLines: 1, bool autofocus: false, Color selectionColor, TextSelectionControls selectionControls, TextInputType keyboardType, TextInputAction textInputAction, TextCapitalization textCapitalization: TextCapitalization.none, ValueChanged<String> onChanged, VoidCallback onEditingComplete, ValueChanged<String> onSubmitted, SelectionChangedCallback onSelectionChanged, List<TextInputFormatter> inputFormatters, bool rendererIgnoresPointer: false, double cursorWidth: 2.0, Radius cursorRadius, EdgeInsets scrollPadding: const EdgeInsets.all(20.0), Brightness keyboardAppearance: Brightness.light })
Creates a basic text input control. [...]


autocorrect → bool
Whether to enable autocorrection. [...]
autofocus → bool
Whether this input field should focus itself if nothing else is already focused. If true, the keyboard will open as soon as this input obtains focus. Otherwise, the keyboard is only shown after the user taps the text field. [...]
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. [...]
cursorWidth → double
How thick the cursor will be. [...]
focusNode FocusNode
Controls whether this widget has keyboard focus.
inputFormatters → List<TextInputFormatter>
Optional input validation and formatting overrides. Formatters are run in the provided order when the text input changes.
keyboardAppearance Brightness
The appearance of the keyboard. [...]
keyboardType TextInputType
The type of keyboard to use for editing the text.
locale Locale
Used to select a font when the same Unicode character can be rendered differently, depending on the locale. [...]
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). [...]
onSelectionChanged SelectionChangedCallback
Called when the user changes the selection of text (including the cursor location).
onSubmitted ValueChanged<String>
Called when the user indicates that they are done editing the text in the field.
rendererIgnoresPointer → bool
If true, the RenderEditable created by this widget will not handle pointer events, see renderEditable and RenderEditable.ignorePointer. [...]
scrollPadding EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view. [...]
selectionColor Color
The color to use when painting the selection.
selectionControls TextSelectionControls
Optional delegate for building the text selection handles and toolbar.
style TextStyle
The text style to use for the editable text.
textAlign TextAlign
How the text should be aligned horizontally. [...]
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 with the soft keyboard.
textScaleFactor → double
The number of font pixels for each logical pixel. [...]
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() EditableTextState
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. [...]

Static Properties

debugDeterministicCursor ↔ bool
Setting this property to true makes the cursor stop blinking and stay visible on the screen continually. This property is most useful for testing purposes. [...]
read / write