AsyncNotifierConsumer<N extends BaseNotifier<BaseAsyncState<S>>, S extends Object?> class

A widget that rebuilds and listens when the BaseAsyncState of the provided BaseNotifier changes.

AsyncNotifierConsumer is a convenience widget for listening to an asynchronous BaseNotifier, rebuilding its child whenever the state changes, and performing side effects via listeners.

N is the type of BaseNotifier and S is the type of data managed by the notifier.

Inheritance

Constructors

AsyncNotifierConsumer({required Widget builder(BaseAsyncState<S> state), required void listener(BaseAsyncState<S> state), bool buildWhen(BaseAsyncState<S> previous, BaseAsyncState<S> current)?, bool listenWhen(BaseAsyncState<S> previous, BaseAsyncState<S> current)?, N notifier()?, void onInit(N notifier)?, Key? key})
Creates an AsyncNotifierConsumer.
const
AsyncNotifierConsumer.withData({required Widget loadingBuilder(), required Widget dataBuilder(S state), required Widget errorBuilder(ErrorState error), void dataListener(S data)?, VoidCallback? loadingListener, void errorListener(ErrorState error)?, bool buildWhen(S? previous, S? current)?, bool listenWhen(S? previous, S? current)?, N notifier()?, void onInit(N notifier)?, Key? key})
dataBuilder is called to build the widget tree when the state is BaseAsyncState.data. loadingBuilder is called when the state is BaseAsyncState.loading. errorBuilder is called when the state is BaseAsyncState.error.

Properties

builder → Widget Function(BaseAsyncState<S> state)?
A function that builds the widget tree based on the current state.
finalinherited
buildWhen → bool Function(BaseAsyncState<S> previous, BaseAsyncState<S> current)?
Optional predicate to determine whether to rebuild when the state changes.
finalinherited
child → Widget?
An optional static child widget to display if builder is not provided.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listener → void Function(BaseAsyncState<S> state)
Callback for side effects when the state changes.
finalinherited
listenWhen → bool Function(BaseAsyncState<S> previous, BaseAsyncState<S> current)?
Optional predicate to determine whether to call listener when the state changes.
finalinherited
notifier → N Function()?
Provides the BaseNotifier instance to listen to. If null, the nearest Provider is used.
finalinherited
onInit → void Function(N notifier)?
An optional callback invoked with the notifier when the widget is initialized. Note: Do not manually call the notifier's onInit() method here. The notifier itself will automatically trigger its own onInit() when it is created, so calling it again would result in duplicate invocations.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<StatefulWidget>
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
whenStateChanged(BaseAsyncState<S> previous, BaseAsyncState<S> current, VoidCallback reBuild) → void
Called when the notifier's state changes.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited