EditableText class Null safety

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).

Handling User Input

Currently the user may change the text this widget contains via keyboard or the text selection menu. When the user inserted or deleted text, you will be notified of the change and get a chance to modify the new text value:

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 a textInputAction 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 textInputActions 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.

Gesture Events Handling

This widget provides rudimentary, platform-agnostic gesture handling for user actions such as tapping, long-pressing and scrolling when rendererIgnoresPointer is false (false by default). To tightly conform to the platform behavior with respect to input gestures in text fields, use TextField or CupertinoTextField. For custom selection behavior, call methods such as RenderEditable.selectPosition, RenderEditable.selectWord, etc. programmatically.

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.

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 readOnly, String obscuringCharacter, bool obscureText, bool autocorrect, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions, required TextStyle style, StrutStyle? strutStyle, required Color cursorColor, required Color backgroundCursorColor, TextAlign textAlign, TextDirection? textDirection, Locale? locale, double? textScaleFactor, int? maxLines, int? minLines, bool expands, bool forceLine, TextHeightBehavior? textHeightBehavior, TextWidthBasis textWidthBasis, bool autofocus, bool? showCursor, bool showSelectionHandles, Color? selectionColor, TextSelectionControls? selectionControls, TextInputType? keyboardType, TextInputAction? textInputAction, TextCapitalization textCapitalization, ValueChanged<String>? onChanged, VoidCallback? onEditingComplete, ValueChanged<String>? onSubmitted, AppPrivateCommandCallback? onAppPrivateCommand, SelectionChangedCallback? onSelectionChanged, VoidCallback? onSelectionHandleTapped, List<TextInputFormatter>? inputFormatters, MouseCursor? mouseCursor, bool rendererIgnoresPointer, double cursorWidth, double? cursorHeight, Radius? cursorRadius, bool cursorOpacityAnimates, Offset? cursorOffset, bool paintCursorAboveText, BoxHeightStyle selectionHeightStyle, BoxWidthStyle selectionWidthStyle, EdgeInsets scrollPadding, Brightness keyboardAppearance, DragStartBehavior dragStartBehavior, bool enableInteractiveSelection, ScrollController? scrollController, ScrollPhysics? scrollPhysics, Color? autocorrectionTextRectColor, ToolbarOptions toolbarOptions, Iterable<String>? autofillHints, Clip clipBehavior, String? restorationId, ScrollBehavior? scrollBehavior, bool enableIMEPersonalizedLearning})
Creates a basic text input control. [...]


autocorrect bool
Whether to enable autocorrection. [...]
autocorrectionTextRectColor Color?
The color to use when painting the autocorrection Rect. [...]
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. [...]
backgroundCursorColor Color
The color to use when painting the background cursor aligned with the text while rendering the floating cursor. [...]
clipBehavior Clip
The content will be clipped (or not) according to this option. [...]
controller TextEditingController
Controls the text being edited.
cursorColor Color
The color to use when painting the cursor. [...]
cursorHeight double?
How tall the cursor will be. [...]
cursorOffset Offset?
The offset that is used, in pixels, when painting the cursor on screen. [...]
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. [...]
dragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled. [...]
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
Controls whether this widget has keyboard focus.
forceLine bool
Whether the text will take the full width regardless of the text width. [...]
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
inputFormatters List<TextInputFormatter>?
Optional input validation and formatting overrides. [...]
key Key?
Controls how one widget replaces another widget in the tree. [...]
final, inherited
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 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). [...]
onSelectionChanged SelectionChangedCallback?
Called when the user changes the selection of text (including the cursor location).
onSelectionHandleTapped VoidCallback?
A callback that's optionally invoked when a selection handle is tapped. [...]
onSubmitted ValueChanged<String>?
Called when the user indicates that they are done editing the text in the field.
paintCursorAboveText bool
If the cursor should be painted on top of the text or underneath it. [...]
readOnly bool
Whether the text can be changed. [...]
rendererIgnoresPointer bool
If true, the RenderEditable created by this widget will not handle pointer events, see RenderEditable and RenderEditable.ignorePointer. [...]
restorationId String?
Restoration ID to save and restore the scroll offset of the EditableText. [...]
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
scrollBehavior ScrollBehavior?
A ScrollBehavior that will be applied to this widget individually. [...]
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. [...]
selectionColor Color?
The color to use when painting the selection. [...]
selectionControls TextSelectionControls?
Optional delegate for building the text selection handles and toolbar. [...]
selectionEnabled bool
Same as enableInteractiveSelection. [...]
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. [...]
showSelectionHandles bool
Whether to show selection handles. [...]
smartDashesType SmartDashesType
Whether to allow the platform to automatically format dashes. [...]
smartQuotesType SmartQuotesType
Whether to allow the platform to automatically format quotes. [...]
strutStyle StrutStyle
The strut style used for the vertical layout. [...]
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. [...]
textHeightBehavior TextHeightBehavior?
Defines how the paragraph will apply TextStyle.height to the ascent of the first line and descent of the last line. [...]
textInputAction TextInputAction?
The type of action button to use with the soft keyboard.
textScaleFactor double?
The number of font pixels for each logical pixel. [...]
textWidthBasis TextWidthBasis
Defines how to measure the width of the rendered text.
toolbarOptions ToolbarOptions
Configuration of toolbar options. [...]


createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
createState() EditableTextState
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
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 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. [...]
@nonVirtual, inherited

Static Properties

debugDeterministicCursor bool
Setting this property to true makes the cursor stop blinking or fading on and off once the cursor appears on focus. This property is useful for testing purposes. [...]
read / write