NotificationBuilder<T extends Notification> class

A widget that builds using notifications dispatched via the build context.

How to use

Define your notification:

  class ColorNotification extends Notification {
  const ColorNotification(this.color);

  final Color color;
}

Use a NotificationBuilder to catch notifications:

NotificationBuilder<ColorNotification>(
  builder: (context, notification, child) {
    // Note: the notification parameter will be null at the very first build.
    // Use a fallback value like this.
    final color = notification?.color ?? Colors.white;

    return AnimatedContainer(
      duration: const Duration(milliseconds: 200),
      curve: Curves.fastOutSlowIn,
      decoration: BoxDecoration(color: color),
      child: child,
    );
  },
  child: const SomeChild(...),
),

Fire notifications from the widget tree below the builder:

onPressed: () {
  ColorNotification(color).dispatch(context);
},

Inheritance

Constructors

NotificationBuilder({Key? key, required _NotificationBuilderFunc<T> builder, Widget? child, _BuildWhenCallback<T>? buildWhen}): const

Properties

builder → _NotificationBuilderFunc<T>: The main builder method that is used to render your widget.
final
buildWhen → _BuildWhenCallback<T>?: The callback that is fired before rebuilding. If the result is false, notification is ignored and the widget is not rebuit.
final
child → Widget?: The child widget to pass to the builder.
final
hashCode → int: The hash code for this object.
no setterinherited
key → Key?: Controls how one widget replaces another widget in the tree.
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<NotificationBuilder<T>>: Creates the mutable state for this widget at a given location in the tree.
override
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}) → 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