SignalsWatch<T> class

A unified class that bundles:

  • Advanced reactive widget (formerly WatchValue)
  • Signals registry utilities
  • Selective signals observer initializer
  • Auto-registering signal/computed factories
Inheritance
Available extensions

Constructors

SignalsWatch({Key? key, required T read(), required Widget builder(T value), Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool shouldRebuild(T newValue, T oldValue)?, bool shouldNotify(T newValue, T oldValue)?, bool equals(T a, T b)?, Duration? debounce, Duration? throttle, void onError(Object error, StackTrace stackTrace)?, Widget errorBuilder(Object error)?, Widget loadingBuilder()?, String? debugLabel, bool debugPrint = false})
Create a SignalsWatch with a custom read function.
const
SignalsWatch.fromSignal(ReadonlySignal<T> signal, {Key? key, required Widget builder(T value), Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool shouldRebuild(T newValue, T oldValue)?, bool shouldNotify(T newValue, T oldValue)?, bool equals(T a, T b)?, Duration? debounce, Duration? throttle, void onError(Object error, StackTrace stackTrace)?, Widget errorBuilder(Object error)?, Widget loadingBuilder()?, String? debugLabel, bool debugPrint = false})
Create a SignalsWatch from a single signal.
const
SignalsWatch.fromSignals(List<ReadonlySignal> signals, {Key? key, required T combine(List values), required Widget builder(T value), Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool shouldRebuild(T newValue, T oldValue)?, bool shouldNotify(T newValue, T oldValue)?, bool equals(T a, T b)?, Duration? debounce, Duration? throttle, void onError(Object error, StackTrace stackTrace)?, Widget errorBuilder(Object error)?, Widget loadingBuilder()?, String? debugLabel, bool debugPrint = false})
Create a SignalsWatch from multiple signals with batch updates.
SignalsWatch.select(ReadonlySignal signal, {Key? key, required T selector(dynamic value), required Widget builder(T value), Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool shouldRebuild(T newValue, T oldValue)?, bool shouldNotify(T newValue, T oldValue)?, bool equals(T a, T b)?, Duration? debounce, Duration? throttle, void onError(Object error, StackTrace stackTrace)?, Widget errorBuilder(Object error)?, Widget loadingBuilder()?, String? debugLabel, bool debugPrint = false})
Create a SignalsWatch with a selector for efficient updates. Only rebuilds when the selected value changes (compared via equals).
const

Properties

builder → Widget Function(T value)
Builds the UI with the current value.
final
debounce → Duration?
Debounce duration. Waits after last change before updating. Default: null (immediate).
final
debugLabel → String?
Debug label for logging.
final
debugPrint → bool
Auto-log all lifecycle events.
final
equals → bool Function(T a, T b)?
Custom equality check. Defaults to ==.
final
errorBuilder → Widget Function(Object error)?
Builder for error states. Defaults to Text with error message.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingBuilder → Widget Function()?
Builder for loading/pending states. Defaults to CircularProgressIndicator.
final
onAfterBuild → Function?
Called post-frame after every build. Signature: (T value) or (T value, T? previous).
final
onDispose → Function?
Called when disposed. Signature: (T value) or (T value, T? previous).
final
onError → void Function(Object error, StackTrace stackTrace)?
Called when an error occurs during read.
final
onInit → Function?
Called once when initialized. Signature: (T value) or (T value, T? previous).
final
onValueUpdated → Function?
Called when value changes. Signature: (T value) or (T value, T? previous).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
shouldNotify → bool Function(T newValue, T oldValue)?
Determines if onValueUpdated should fire. Defaults to checking equality.
final
shouldRebuild → bool Function(T newValue, T oldValue)?
Determines if the widget should rebuild. Return false to skip rebuild.
final
throttle → Duration?
Throttle duration. Ignores changes within this duration. Default: null (no throttle).
final

Methods

addMaterialWidget() → Material

Available on Widget, provided by the GenericExtensions extension

addTooltipWidget(String toolTip) → Tooltip

Available on Widget, provided by the GenericExtensions extension

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
borderRadius([BorderRadiusGeometry? borderRadius]) → Widget

Available on Widget, provided by the GenericExtensions extension

boxDecoration([BoxDecoration? boxDecoration]) → Widget

Available on Widget, provided by the GenericExtensions extension

colorFilter([ColorFilter? colorFilter]) → Widget

Available on Widget, provided by the GenericExtensions extension

set parent widget in center
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SignalsWatch<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, 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

Static Properties

size → int
Number of currently registered signals/computeds.
no setter

Static Methods

computed<T>(T compute(), {String? debugLabel, bool autoDispose = false, Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool debugTrace = false, Map<String, dynamic>? metadata}) → Computed<T>
Auto-registering replacement for signals.computed.
disposeAll() → void
Disposes all tracked signals (manual global teardown).
fromFuture<T>(Future<T> future, {T? initialValue, String? debugLabel, bool autoDispose = false, void onError(Object error, StackTrace stackTrace)?, Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool debugTrace = false, Map<String, dynamic>? metadata}) → Signal<T?>
Create a signal from a Future.
fromStream<T>(Stream<T> stream, {T? initialValue, String? debugLabel, bool autoDispose = false, bool cancelOnError = false, void onError(Object error, StackTrace stackTrace)?, Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool debugTrace = false, Map<String, dynamic>? metadata}) → Signal<T?>
Create a signal from a Stream.
initializeSignalsObserver() → void
Initialize the global SignalsObserver with a selective logger that only logs labeled signals.
register<S extends ReadonlySignal>(S signal) → S
Registers a signal/computed and sets up automatic removal on dispose. Returns the SAME instance passed in (preserves concrete type).
signal<T>(T initialValue, {String? debugLabel, bool autoDispose = false, Function? onInit, Function? onValueUpdated, Function? onAfterBuild, Function? onDispose, bool debugTrace = false, Map<String, dynamic>? metadata}) → Signal<T>
Auto-registering replacement for signals.signal.
unregister(ReadonlySignal signal) → void
Manually unregister (rarely needed; dispose normally handles this).