FormBuilder class

A container for form fields.

Inheritance

Constructors

FormBuilder({Key? key, required Widget child, VoidCallback? onChanged, AutovalidateMode? autovalidateMode, WillPopCallback? onWillPop, Map<String, dynamic> initialValue = const <String, dynamic>{}, bool skipDisabled = false, bool enabled = true, bool autoFocusOnValidationFailure = false, bool clearValueOnUnregister = false})
Creates a container for form fields.
const

Properties

autoFocusOnValidationFailure bool
Whether the form should auto focus on the first field that fails validation.
final
autovalidateMode AutovalidateMode?
Used to enable/disable form fields auto validation and update their error text.
final
child Widget
The widget below this widget in the tree.
final
clearValueOnUnregister bool
Whether to clear the internal value of a field when it is unregistered.
final
enabled bool
Whether the form is able to receive user input.
final
hashCode int
The hash code for this object.
no setterinherited
initialValue Map<String, dynamic>
An optional Map of field initialValues. Keys correspond to the field's name and value to the initialValue of the field.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onChanged VoidCallback?
Called when one of the form fields changes.
final
onWillPop WillPopCallback?
Enables the form to veto attempts by the user to dismiss the ModalRoute that contains the form.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
skipDisabled bool
Whether the form should ignore submitting values from fields where enabled is false. This behavior is common in HTML forms where readonly values are not submitted when the form is submitted.
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() FormBuilderState
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

Static Methods

of(BuildContext context) FormBuilderState?