AutoFormFieldWrapper<T> class

A generic form field wrapper that can wrap any widget and add validation.

This widget can be used to add validation to any widget (checkbox, dropdown, etc.) and display error messages below the widget when validation fails.

Example usage with checkbox:

AutoFormField<bool?>(
  formController: CheckboxController(),
  builder: (field) => Checkbox(
    value: _isChecked,
    onChanged: (value) {
      setState(() => _isChecked = value);
      field.didChange(value);
    },
  ),
)

Example usage with dropdown:

AutoFormField<MyEnum?>(
  formController: DropdownController(),
  builder: (field) => DropdownButton<MyEnum>(
    value: _selectedValue,
    items: [...],
    onChanged: (value) {
      setState(() => _selectedValue = value);
      field.didChange(value);
    },
  ),
)
Inheritance

Constructors

AutoFormFieldWrapper({Key? key, CustomFormController<T>? formController, String? validator(T? value)?, required Widget builder(FormFieldState<T> field), FocusNode? focusNode, T? initialValue, Widget errorWidget(String errorText)?})

Properties

autovalidateMode → AutovalidateMode
Used to enable/disable this form field auto validation and update its error text.
finalinherited
builder → FormFieldBuilder<T>
Function that returns the widget representing this form field.
finalinherited
enabled → bool
Whether the form is able to receive user input.
finalinherited
errorBuilder → FormFieldErrorBuilder?
Function that returns the widget representing the error to display.
finalinherited
errorWidget → Widget Function(String errorText)?
final
focusNode → FocusNode?
Custom focus node
final
forceErrorText → String?
An optional property that forces the FormFieldState into an error state by directly setting the FormFieldState.errorText property without running the validator function.
finalinherited
formController → CustomFormController<T>?
The form controller that handles validation
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.
finalinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onReset → VoidCallback?
An optional method to call when the form field is reset via FormFieldState.reset.
finalinherited
onSaved → FormFieldSetter<T>?
An optional method to call with the final value when the form is saved via FormState.save.
finalinherited
restorationId → String?
Restoration ID to save and restore the state of the form field.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
validator → FormFieldValidator<T>?
An optional method that validates an input. Returns an error string to display if the input is invalid, or null otherwise.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → FormFieldState<T>
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
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, int wrapWidth = 65}) → 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