EasyFormField<T> class

A single form field.

The name field is required to set the key in the map for onSave in the EasyForm widget.

This widget maintains the current state of the form field, so that updates and validation errors are visually reflected in the UI.

When used inside a EasyForm, you can use methods on EasyFormState to query or manipulate the form data as a whole. For example, calling EasyFormState.save will invoke each EasyFormField's onSaved callback in turn.

Use a GlobalKey with EasyFormField if you want to retrieve its current state, for example if you want one form field to depend on another.

A EasyForm ancestor is not required. The EasyForm simply makes it easier to save, reset, or validate multiple fields at once. To use without a EasyForm, pass a GlobalKey to the constructor and use GlobalKey.currentState to save or reset the form field.

See also:

Inheritance
Implementers

Constructors

EasyFormField({Key? key, required String name, required EasyFormFieldBuilder<T> builder, FocusNode? focusNode, EasyFormFieldSetter<T>? onSaved, EasyFormFieldValidator<T>? validator, T? initialValue, bool enabled = true, EasyAutovalidateMode autovalidateMode = EasyAutovalidateMode.disabled})
Creates a single form field.
const

Properties

autovalidateMode → EasyAutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
final
builder → EasyFormFieldBuilder<T>
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.
final
enabled → bool
Whether the form is able to receive user input.
final
focusNode → FocusNode?
Focus node.
final
hashCode → int
The hash code for this object.
no setterinherited
initialValue → T?
An optional value to initialize the form field to, or null otherwise.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
name → String
Name of the field.
final
onSaved → EasyFormFieldSetter<T>?
An optional method to call with the final value when the form is saved via EasyFormState.save.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validator → EasyFormFieldValidator<T>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → EasyFormFieldState<T>
Creates the mutable state for this widget at a given location in the tree.
override
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
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

Operators

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