EasyTextFormField class

A EasyCustomFormField that contains a TextField.

This is a convenience widget that wraps a TextField widget in a EasyCustomFormField.

When a controller is specified, its TextEditingController.text defines the initialValue. If this EasyTextFormField is part of a scrolling container that lazily constructs its children, like a ListView or a CustomScrollView, then a controller should be specified. The controller's lifetime should be managed by a stateful widget ancestor of the scrolling container.

If a controller is not specified, initialValue can be used to give the automatically generated controller an initial value.

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.

By default, decoration will apply the ThemeData.inputDecorationTheme for the current context to the InputDecoration, see InputDecoration.applyDefaults.

For a documentation about the various parameters, see TextField.

Creates a EasyTextFormField with an InputDecoration and validator function.

If the user enters valid text, the TextField appears normally without any warnings to the user

If the user enters invalid text, the error message returned from the validator function is displayed in dark red underneath the input

EasyTextFormField(
  name: 'name',
  decoration: const InputDecoration(
    icon: Icon(Icons.person),
    hintText: 'What do people call you?',
    labelText: 'Name *',
  ),
  validator: (String value) {
    return value.contains('@') ? 'Do not use the @ char.' : null;
  },
)

See also:

Inheritance

Constructors

EasyTextFormField({Key? key, required String name, TextEditingController? controller, String? initialValue, FocusNode? focusNode, InputDecoration decoration = const InputDecoration(), TextInputType? keyboardType, TextCapitalization textCapitalization = TextCapitalization.none, TextInputAction? textInputAction, TextStyle? style, StrutStyle? strutStyle, TextDirection? textDirection, TextAlign textAlign = TextAlign.start, TextAlignVertical? textAlignVertical, bool autofocus = false, bool readOnly = false, @Deprecated('Use `contextMenuBuilder` instead.') ToolbarOptions? toolbarOptions, bool? showCursor, String obscuringCharacter = '•', bool obscureText = false, bool autocorrect = true, SmartDashesType? smartDashesType, SmartQuotesType? smartQuotesType, bool enableSuggestions = true, MaxLengthEnforcement? maxLengthEnforcement, int maxLines = 1, int? minLines, bool expands = false, int? maxLength, ValueChanged<String>? onChanged, GestureTapCallback? onTap, VoidCallback? onEditingComplete, ValueChanged<String>? onFieldSubmitted, FormFieldSetter<String>? onSaved, EasyFormFieldValidator<String?>? validator, List<TextInputFormatter>? inputFormatters, bool enabled = true, double cursorWidth = 2.0, double? cursorHeight, Radius? cursorRadius, Color? cursorColor, Brightness? keyboardAppearance, EdgeInsets scrollPadding = const EdgeInsets.all(20.0), bool enableInteractiveSelection = true, InputCounterWidgetBuilder? buildCounter, ScrollPhysics? scrollPhysics, Iterable<String>? autofillHints, ContentInsertionConfiguration? contentInsertionConfiguration, Clip clipBehavior = Clip.hardEdge, String? restorationId, bool scribbleEnabled = true, bool enableIMEPersonalizedLearning = true, EditableTextContextMenuBuilder? contextMenuBuilder, bool canRequestFocus = true, SpellCheckConfiguration? spellCheckConfiguration, TextMagnifierConfiguration? magnifierConfiguration, EasyAutovalidateMode autovalidateMode = EasyAutovalidateMode.disabled, bool saveOnSubmit = false})
Creates a EasyCustomFormField that contains a TextField.
EasyTextFormField.builder({Key? key, required String name, required EasyFormCustomFieldBuilder<String, TextEditingController> builder, TextEditingController? controller, String? initialValue, ValueChanged<String>? onChanged, FormFieldSetter<String>? onSaved, EasyFormFieldValidator<String?>? validator, bool enabled = true, EasyAutovalidateMode autovalidateMode = EasyAutovalidateMode.disabled})
Creates EasyCustomFormField, which builds TextField using a builder.

Properties

autovalidateMode → EasyAutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → EasyFormFieldBuilder<String?>
Function that returns the widget representing this form field. It is passed the form field state as input, containing the current value and validation state of this field.
finalinherited
controller → TextEditingController?
Controls the value being edited.
finalinherited
controllerBuilder → CreateControllerCallback<TextEditingController, String?>
A builder that instantiates a controller of type C for a value of type T.
finalinherited
controllerRebuilder → RecreateControllerCallback<TextEditingController>?
A builder that recreates a controller from an old controller, if not specified, the controllerBuilder builder will be used.
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
focusNode → FocusNode?
Focus node.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
initialValue → String?
An optional value to initialize the form field to, or null otherwise.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
name → String
Name of the field.
finalinherited
onSaved → EasyFormFieldSetter<String?>?
An optional method to call with the final value when the form is saved via EasyFormState.save.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validator → EasyFormFieldValidator<String?>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited
valueGet → ValueOfGetter<String?, TextEditingController>?
Callback to get the value from the controller, if not set then the controller's value property is used.
finalinherited
valueSet → ValueOfSetter<String?, TextEditingController>?
Callback to set controller value, if not set - controller's value property is used.
finalinherited

Methods

createController(String value) → TextEditingController
A builder that instantiates a controller of type C for a value of type T.
inherited
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _EasyCustomFormFieldState<String, TextEditingController>
Creates the mutable state for this widget at a given location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
recreateController(TextEditingController oldController) → TextEditingController
A builder that recreates a controller from an old controller.
inherited
setValue(TextEditingController controller, String? value) → dynamic
Setter, to set the controller value.
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.info}) → String
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
valueOf(TextEditingController controller) → String?
Getter, to get the value from the controller.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited