NotifierConsumer<N extends BaseNotifier<S> , S extends Object?> class
A widget that both rebuilds and listens to state changes from a BaseNotifier
.
NotifierConsumer allows you to rebuild the widget tree and perform side effects
in response to state changes, using buildWhen
and listenWhen
to control behavior.
N
is the type of BaseNotifier
and S
is the type of state managed by the notifier.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- SingleChildStatefulWidget
- NotifierConsumer
- Implemented types
- Implementers
Constructors
-
NotifierConsumer.new({required BuilderCallback<
S> builder, required void listener(S state)?, ShouldProceedCallback<S> ? listenWhen, ShouldProceedCallback<S> ? buildWhen, Widget? child, void onInit(N notifier)?, Key? key}) -
Creates a NotifierConsumer.
const
Properties
-
builder
→ BuilderCallback<
S> ? -
Function to build the widget based on the current state and optional child.
finalinherited
-
buildWhen
→ ShouldProceedCallback<
S> ? -
Function to determine if the widget should rebuild when state changes.
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(S state)?
-
Function to execute when state changes without triggering a rebuild.
finalinherited
-
listenWhen
→ ShouldProceedCallback<
S> ? -
Function to determine if the listener should be called when state changes.
finalinherited
- onInit → void Function(N notifier)?
-
Function to execute when the widget is first created.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → SingleChildStatefulElement -
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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited