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 InheritedComponent.updateShouldNotify
for more information.
See also:
- Future, which is listened by FutureProvider.
- Inheritance
-
- Object
- SingleChildStatelessComponent
- InheritedProvider<
T> - DeferredInheritedProvider<
Future< T> ?, T> - FutureProvider
Constructors
-
FutureProvider({Key? key, required Create<
Future< create, required T initialData, ErrorBuilder<T> ?>T> ? catchError, UpdateShouldNotify<T> ? updateShouldNotify, bool? lazy, TransitionBuilder? builder, Component? child}) -
Creates a Future from
create
and subscribes to it. -
FutureProvider.value({Key? key, required Future<
T> ? value, required T initialData, ErrorBuilder<T> ? catchError, UpdateShouldNotify<T> ? updateShouldNotify, TransitionBuilder? builder, Component? child}) -
Listens to
value
and 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 component replaces another component in the tree.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
build(
BuildContext context) → Iterable< Component> -
Describes the part of the user interface represented by this component.
inherited
-
buildWithChild(
BuildContext context, Component? child) → Iterable< Component> -
A build method that receives an extra
child
parameter.inherited -
createElement(
) → _InheritedProviderElement< T> -
Creates a
StatelessElement
to manage this component's location in the tree.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited