FormProvider<T extends FormManager> class

Takes a ValueBuilder that is responsible for creating the formManager and a child which will have access to the formManager via FormProvider.of(context). It is used as a dependency injection (DI) widget so that a single instance of a formManager can be provided to multiple widgets within a subtree.

Automatically handles closing the formManager when used with create and lazily creates the provided formManager unless lazy is set to false.

FormProvider(
  create: (BuildContext context) => FormManagerA(),
  child: ChildA(),
);
Inheritance

Constructors

FormProvider({Key? key, required CreateFormManager<T> create, Widget? child, bool? lazy})
FormProvider.value({Key? key, required T value, Widget? child})
Takes a formManager and a child which will have access to the formManager via FormProvider.of(context). When FormProvider.value is used, the formManager will not be automatically closed. As a result, FormProvider.value should mainly be used for providing existing formManagers to new routes.

Properties

child Widget?
child and its descendants which will have access to the formManager.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lazy bool?
Whether or not the formManager being provided should be lazily created. Defaults to true.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
inherited
buildWithChild(BuildContext context, Widget? child) Widget
A build method that receives an extra child parameter.
override
createElement() → SingleChildStatelessElement
Creates a StatelessElement to manage this widget's 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}) 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<T extends FormManager>(BuildContext context) → T
Method that allows widgets to access a formManager instance as long as their BuildContext contains a FormProvider instance.