NotifierConsumer<N extends BaseNotifier<S>, S extends Object?> constructor

const NotifierConsumer<N extends BaseNotifier<S>, S extends Object?>({
  1. required Widget builder(
    1. S state
    ),
  2. required void listener(
    1. S state
    ),
  3. bool listenWhen(
    1. S previous,
    2. S current
    )?,
  4. bool buildWhen(
    1. S previous,
    2. S current
    )?,
  5. N notifier()?,
  6. void onInit(
    1. N notifier
    )?,
  7. Key? key,
})

Creates a NotifierConsumer.

builder is called to build the widget tree based on the current state.

listener is called for side effects when the state changes.

buildWhen is an optional predicate that determines whether to rebuild when the state changes.

listenWhen is an optional predicate that determines whether to call listener when the state changes.

onInit is 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.

Example (incorrect usage):

NotifierConsumer<Notifier, State>(
  // Do NOT do this:
  onInit: (notifier) => notifier.onInit(),
  builder: (context, state) => Text('State: $state'),
)

key is the widget key.

Implementation

const NotifierConsumer({
  required Widget Function(S state) super.builder,
  required this.listener,
  this.listenWhen,
  this.buildWhen,
  super.notifier,
  super.onInit,
  super.key,
});