OnBuilder<T> class

Explicitly listenTo one or more injected state and reinvoke its onBuilder callback each time an injected state emits a notification.

For each OnBuilder widget flavor there is method like equivalent:

//Widget-like
OnBuilder(
    listenTo: counter,
    builder: () => Text('${counter.state}'),
),

//Method-like
counter.rebuild(
    () => Text('{counter.state}'),
),
//
//Widget-like
OnBuilder.data(
    listenTo: counter,
    builder: (data) => Text('$data')),
),

//Method-like
counter.rebuild.onData(
    (data) => Text(data),
),

//Widget-like
OnBuilder.all(
    listenTo: counter,
    onIdle: () => Text('onIdle'),
    onWaiting: () => Text('onWaiting'),
    onError: (err, errorRefresh) => Text('onError'),
    onData: (data) => Text('$data'),

)

//Method-like
counter.rebuild.onAll(
    onIdle: () => Text('onIdle'),
    onWaiting: () => Text('onWaiting'),
    onError: (err, errorRefresh) => Text('onError'),
    onData: (data) => Text('$data'),
),
//
//Widget-like
OnBuilder.orElse(
    listenTo: counter,
    onWaiting: () => Text('onWaiting'),
    orElse: (_) => Text('{counter.state}'),

),

//Method-like
counter.rebuild.onOrElse(
    onWaiting: () => Text('onWaiting'),
    orElse: (_) => Text('{counter.state}'),
),
Inheritance
Implementers

Constructors

OnBuilder({Key? key, IObservable<T>? listenTo, List<IObservable>? listenToMany, required Widget builder(), SideEffects<T>? sideEffects, ShouldRebuild? shouldRebuild, Object? watch()?, String? debugPrintWhenRebuild})
Explicitly listenTo one or more injected state and reinvoke its onBuilder callback each time an injected state emits a notification.
OnBuilder.all({Key? key, IObservable<T>? listenTo, List<IObservable>? listenToMany, OnIdle? onIdle, required OnWaiting onWaiting, required OnError onError, required OnData<T> onData, SideEffects<T>? sideEffects, ShouldRebuild? shouldRebuild, Object? watch()?, String? debugPrintWhenRebuild})
Explicitly listenTo one or more injected state and reinvoke its onBuilder callback each time an injected state emits a notification.
OnBuilder.bindingObserver({Key? key, IObservable<T>? listenTo, required Widget builder(), SideEffects<T>? sideEffects, ShouldRebuild? shouldRebuild, void didChangeAppLifecycleState(BuildContext context, AppLifecycleState state)?, void didChangeLocales(BuildContext context, List<Locale>? locale)?})
Create a widget that registers with the Widgets layer binding. Used to track the app life cycle (AppLifecycleState).
factory
OnBuilder.create({Key? key, @Deprecated('Use creator instead') ReactiveModel<T> create()?, T creator()?, SideEffects<T>? sideEffects, required Widget builder(ReactiveModel<T> rm)})
If creator is null, a ReactiveModel
OnBuilder.createFuture({Key? key, required Future<T> creator(), T? initialState, SideEffects<T>? sideEffects, required Widget builder(ReactiveModel<T> rm)})
Create a ReactiveModel state from a future and listen to it
OnBuilder.createStream({Key? key, required Stream<T> creator(), T? initialState, SideEffects<T>? sideEffects, required Widget builder(ReactiveModel<T> rm)})
Create a ReactiveModel state from a stream and listen to it
OnBuilder.data({Key? key, IObservable<T>? listenTo, List<IObservable>? listenToMany, required Widget builder(T data), SideEffects<T>? sideEffects, ShouldRebuild? shouldRebuild, Object? watch()?, String? debugPrintWhenRebuild})
Explicitly listenTo one or more injected state and reinvoke its onBuilder callback each time an injected state emits a notification.
OnBuilder.orElse({Key? key, IObservable<T>? listenTo, List<IObservable>? listenToMany, Widget onIdle()?, Widget onWaiting()?, Widget onError(dynamic error, void refreshError())?, Widget onData(T data)?, required Widget orElse(T data), SideEffects<T>? sideEffects, ShouldRebuild? shouldRebuild, Object? watch()?, String? debugPrintWhenRebuild})
Explicitly listenTo one or more injected state and reinvoke its onBuilder callback each time an injected state emits a notification.

Properties

cleaners List<VoidCallback>
finalinherited
debugPrintWhenRebuild String?
finalinherited
didChangeDependencies → (void Function(BuildContext context, ReactiveModel<T>? model)?)
finalinherited
didUpdateWidget → (void Function(BuildContext context, ReactiveModel<T>? model, MyStatefulWidget<T> oldWidget)?)
finalinherited
dispose → (void Function(BuildContext context, ReactiveModel<T>? model)?)
finalinherited
hashCode int
The hash code for this object.
no setterinherited
initState → (void Function(BuildContext context, ReactiveModel<T>? model)?)
finalinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
observers List<ReactiveModelImp> Function(BuildContext context)
finalinherited
onSetState → (void Function(BuildContext, SnapState<T>, ReactiveModel<T>)?)
finalinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shouldRebuild ShouldRebuild?
Whether to rebuild the widget after state notification.
finalinherited
sideEffects SideEffects<T>?
finalinherited

Methods

builder(BuildContext context, SnapState<T> snap, ReactiveModel<T> rm) Widget
inherited
createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _MyStatefulWidgetState<T>
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}) 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