TextInputConfiguration class

Controls the visual appearance of the text input control.

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 text input is attached. 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.

See also:

Annotations
  • @immutable

Constructors

TextInputConfiguration({TextInputType inputType: TextInputType.text, bool obscureText: false, bool autocorrect: true, String actionLabel, TextInputAction inputAction: TextInputAction.done, Brightness keyboardAppearance: Brightness.light, TextCapitalization textCapitalization: TextCapitalization.none })
Creates configuration information for a text input control. [...]
const

Properties

actionLabel String
What text to display in the text input control's action button.
final
autocorrect bool
Whether to enable autocorrection. [...]
final
inputAction TextInputAction
What kind of action to request for the action button on the IME.
final
inputType TextInputType
The type of information for which to optimize the text input control.
final
keyboardAppearance Brightness
The appearance of the keyboard. [...]
final
obscureText bool
Whether to hide the text being edited (e.g., for passwords). [...]
final
textCapitalization TextCapitalization
Specifies how platforms may automatically capitialize text entered by the user. [...]
final
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

toJson() Map<String, dynamic>
Returns a representation of this object as a JSON object.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
@pragma('vm:entry-point'), inherited
toString() String
Returns a string representation of this object.
inherited

Operators

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