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.

Lifecycle

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.

See also:

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

Constructors

EditableText({Key key, @required TextEditingController controller, @required FocusNode focusNode, bool readOnly: false, bool obscureText: false, bool autocorrect: true, @required TextStyle style, StrutStyle strutStyle, @required Color cursorColor, @required Color backgroundCursorColor, TextAlign textAlign: TextAlign.start, TextDirection textDirection, Locale locale, double textScaleFactor, int maxLines: 1, int minLines, bool expands: false, bool forceLine: true, TextWidthBasis textWidthBasis: TextWidthBasis.parent, bool autofocus: false, bool showCursor, bool showSelectionHandles: false, Color selectionColor, TextSelectionControls selectionControls, TextInputType keyboardType, TextInputAction textInputAction, TextCapitalization textCapitalization: TextCapitalization.none, ValueChanged<String> onChanged, VoidCallback onEditingComplete, ValueChanged<String> onSubmitted, SelectionChangedCallback onSelectionChanged, VoidCallback onSelectionHandleTapped, List<TextInputFormatter> inputFormatters, bool rendererIgnoresPointer: false, double cursorWidth: 2.0, Radius cursorRadius, bool cursorOpacityAnimates: false, Offset cursorOffset, bool paintCursorAboveText: false, EdgeInsets scrollPadding: const EdgeInsets.all(20.0), Brightness keyboardAppearance: Brightness.light, DragStartBehavior dragStartBehavior: DragStartBehavior.start, bool enableInteractiveSelection: true, ScrollController scrollController, ScrollPhysics scrollPhysics, ToolbarOptions toolbarOptions: const ToolbarOptions(copy: true, cut: true, paste: true, selectAll: true) })
Creates a basic text input control. [...]

Properties

autocorrect bool
Whether to enable autocorrection. [...]
final
autofocus bool
Whether this text field should focus itself if nothing else is already focused. [...]
final
backgroundCursorColor Color
The color to use when painting the background cursor aligned with the text while rendering the floating cursor. [...]
final
controller TextEditingController
Controls the text being edited.
final
cursorColor Color
The color to use when painting the cursor. [...]
final
cursorOffset Offset
The offset that is used, in pixels, when painting the cursor on screen. [...]
final
cursorOpacityAnimates bool
Whether the cursor will animate from fully transparent to fully opaque during each cursor blink. [...]
final
cursorRadius Radius
How rounded the corners of the cursor should be. [...]
final
cursorWidth double
How thick the cursor will be. [...]
final
dragStartBehavior DragStartBehavior
Determines the way that drag start behavior is handled. [...]
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
expands bool
Whether this widget's height will be sized to fill its parent. [...]
final
focusNode FocusNode
Controls whether this widget has keyboard focus.
final
forceLine bool
Whether the text will take the full width regardless of the text width. [...]
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
locale Locale
Used to select a font when the same Unicode character can be rendered differently, depending on the locale. [...]
final
maxLines int
The maximum number of lines for the text to span, wrapping if necessary. [...]
final
minLines int
The minimum number of lines to occupy when the content spans fewer lines. When maxLines is set as well, the height will grow between the indicated range of lines. When maxLines is null, it will grow as high as needed, starting from minLines. [...]
final
obscureText bool
Whether to hide the text being edited (e.g., for passwords). [...]
final
onChanged ValueChanged<String>
Called when the user initiates a change to the TextField's value: when they have inserted or deleted text. [...]
final
onEditingComplete VoidCallback
Called when the user submits editable content (e.g., user presses the "done" button on the keyboard). [...]
final
onSelectionChanged SelectionChangedCallback
Called when the user changes the selection of text (including the cursor location).
final
onSelectionHandleTapped VoidCallback
A callback that's invoked when a selection handle is tapped. [...]
final
onSubmitted ValueChanged<String>
Called when the user indicates that they are done editing the text in the field. [...]
final
paintCursorAboveText bool
If the cursor should be painted on top of the text or underneath it. [...]
final
readOnly bool
Whether the text can be changed. [...]
final
rendererIgnoresPointer bool
If true, the RenderEditable created by this widget will not handle pointer events, see renderEditable and RenderEditable.ignorePointer. [...]
final
scrollController ScrollController
The ScrollController to use when vertically scrolling the input. [...]
final
scrollPadding EdgeInsets
Configures padding to edges surrounding a Scrollable when the Textfield scrolls into view. [...]
final
scrollPhysics ScrollPhysics
The ScrollPhysics to use when vertically scrolling the input. [...]
final
selectionColor Color
The color to use when painting the selection.
final
selectionControls TextSelectionControls
Optional delegate for building the text selection handles and toolbar. [...]
final
selectionEnabled bool
True if interactive selection is enabled based on the values of enableInteractiveSelection and obscureText. [...]
read-only
showCursor bool
Whether to show cursor. [...]
final
showSelectionHandles bool
Whether to show selection handles. [...]
final
strutStyle StrutStyle
The strut style used for the vertical layout. [...]
read-only
style TextStyle
The text style to use for the editable text.
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 with the soft keyboard.
final
textScaleFactor double
The number of font pixels for each logical pixel. [...]
final
textWidthBasis TextWidthBasis
null
final
toolbarOptions ToolbarOptions
Configuration of toolbar options. [...]
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() EditableTextState
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 DiagnosticsNode.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

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