NotifierRegister<N extends BaseNotifier<Object?>> class

A widget that registers a BaseNotifier in the widget tree using ChangeNotifierProvider.

NotifierRegister is a convenience widget for providing a notifier to its descendants, making it accessible throughout the widget subtree. It acts as a wrapper around Flutter's ChangeNotifierProvider with SyncX-specific optimizations.

N is the type of BaseNotifier.

This widget supports two creation patterns:

Example usage:

// Create a new notifier instance
NotifierRegister<CounterNotifier>(
  create: (context) => CounterNotifier(),
  child: MyApp(),
)

// Provide an existing notifier instance
NotifierRegister<CounterNotifier>.value(
  notifier: existingCounterNotifier,
  child: MyApp(),
)
Inheritance

Constructors

NotifierRegister({required N create(BuildContext context)?, bool? lazy, Widget? child, Widget builder(BuildContext context, Widget? child)?, Key? key})
Creates a NotifierRegister that creates a new notifier instance.
const
NotifierRegister.value({required N notifier, Widget? child, Widget builder(BuildContext context, Widget? child)?, Key? key})
Creates a NotifierRegister.value that provides an existing notifier instance.
const

Properties

builder → Widget Function(BuildContext context, Widget? child)?
An optional builder function for customizing the widget tree.
final
child → Widget?
An optional static child widget.
final
create → N Function(BuildContext context)?
A function that creates a new notifier instance.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lazy → bool?
Whether the notifier should be created lazily.
final
notifier → N?
The existing notifier instance to provide.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's 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