Core topic

This list is a set of important objects to interact with "providers".

Some key objects are:

  • AsyncValue, to allow the UI to change its rendering based on the status of a provider
  • ProviderContainer/ProviderScope: The entrypoint of Riverpod, and also where you can pass various configurations (such as scoping, observers, ...)
  • Ref/WidgetRef, to read/listen to providers
  • ConsumerWidget, Consumer, etc... Those are widgets to allow the UI to obtain a WidgetRef

Classes

AsyncData<ValueT> Core
Creates an AsyncValue with a data.
AsyncError<ValueT> Core
Creates an AsyncValue in the error state.
AsyncLoading<ValueT> Core
Creates an AsyncValue in loading state.
AsyncValue<ValueT> Core
A utility for safely manipulating asynchronous data.
Consumer Core
Build a widget tree while listening to providers.
ConsumerState<T extends ConsumerStatefulWidget> Core
The State for a ConsumerStatefulWidget.
ConsumerStatefulWidget Core
A StatefulWidget that has a State capable of reading providers.
ConsumerWidget Core
The equivalent of a StatelessWidget that can listen to providers.
ProviderContainer Core
An object that stores the state of the providers and allows overriding the behavior of a specific provider.
ProviderObserver Core
An object that listens to the changes of a ProviderContainer.
ProviderObserverContext Core
Information about the ProviderObserver event.
ProviderScope Core
A widget that stores the state of providers.
ProviderSubscription<OutT> Core
Represents the subscription to a ProviderListenable.
Ref Core
An object used by providers to interact with other providers and the life-cycles of the application.
UncontrolledProviderScope Core
Expose a ProviderContainer to the widget tree.
WidgetRef Core
An object that allows widgets to interact with providers.