FutureProvider<T> class
Listens to a Future and exposes its result to child and its descendants.
It is considered an error to pass a future that can emit errors without
providing a catchError method.
updateShouldNotify can optionally be passed to avoid unnecessarily
rebuilding dependents when Provider is rebuilt but value did not change.
Defaults to (previous, next) => previous != next.
See InheritedWidget.updateShouldNotify for more information.
See also:
- Future, which is listened by FutureProvider.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- SingleChildStatelessWidget
- InheritedProvider<
T> - DeferredInheritedProvider<
Future< T> ?, T> - FutureProvider
- Implemented types
Constructors
-
FutureProvider({Key? key, required Create<
Future< create, required T initialData, ErrorBuilder<T> ?>T> ? catchError, UpdateShouldNotify<T> ? updateShouldNotify, bool? lazy, TransitionBuilder? builder, Widget? child}) -
Creates a Future from
createand subscribes to it. -
FutureProvider.value({Key? key, required Future<
T> ? value, required T initialData, ErrorBuilder<T> ? catchError, UpdateShouldNotify<T> ? updateShouldNotify, TransitionBuilder? builder, Widget? child}) -
Listens to
valueand expose it to all of FutureProvider descendants.
Properties
- builder → TransitionBuilder?
-
Syntax sugar for obtaining a BuildContext that can read the provider
created.
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- 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
childparameter.inherited -
createElement(
) → _InheritedProviderElement< T> -
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, 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