SignalsMixin<T extends StatefulWidget> mixin

Signals mixin that will automatically rebuild the widget tree when any of the signals change and dispose of any signals and effects created locally.

class MyWidget extends StatefulWidget {
 ...
}

class _MyWidget extends State<MyWidget> with SignalsMixin {
  late var _signal = this.createSignal(0);
  late var _computed = this.createComputed(() => _signal() * 2);

  @override
  void initState() {
    super.initState();
    this.createEffect(() {
      print('count: $_signal, double: $_computed');
    });
  }
  ...
}
Superclass constraints

Properties

context → BuildContext
The location in the tree where this widget builds.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
mounted → bool
Whether this State object is currently in a tree.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
widget → T
The current configuration.
no setterinherited

Methods

activate() → void
Called when this object is reinserted into the tree after having been removed via deactivate.
inherited
bindSignal<V, S extends ReadonlySignal<V>>(S val) → S
Bind an existing signal
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
inherited
clearSignalsAndEffects() → void
Reset all stored signals and effects
createComputed<V>(V cb(), {String? debugLabel, bool autoDispose = true}) → Computed<V>
Create a computed
createEffect(dynamic cb(), {String? debugLabel, dynamic onDispose()?}) → EffectCleanup
Create a effect.
createListSignal<V>(List<V> list, {String? debugLabel, bool autoDispose = true}) → ListSignal<V>
Create a ListSignal
createMapSignal<K, V>(Map<K, V> value, {String? debugLabel, bool autoDispose = true}) → MapSignal<K, V>
Create a MapSignal
createQueueSignal<V>(Queue<V> queue, {String? debugLabel, bool autoDispose = true}) → QueueSignal<V>
Create a QueueSignal
createSetSignal<V>(Set<V> set, {String? debugLabel, bool autoDispose = true}) → SetSignal<V>
Create a SetSignal
createSignal<V>(V val, {String? debugLabel, bool autoDispose = true}) → Signal<V>
Create a signal
deactivate() → void
Called when this object is removed from the tree.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
didChangeDependencies() → void
Called when a dependency of this State object changes.
inherited
didUpdateWidget(covariant T oldWidget) → void
Called whenever the widget configuration changes.
inherited
dispose() → void
Called when this object is removed from the tree permanently.
override
disposeSignal(int id) → void
Dispose and remove signal
initState() → void
Called when this object is inserted into the tree.
inherited
listenSignal(ReadonlySignal target, void callback(), {String? debugLabel}) → void
Watch signal value
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
reassemble() → void
Called whenever the application is reassembled during debugging, for example during hot reload.
inherited
setState(VoidCallback fn) → void
Notify the framework that the internal state of this object has changed.
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
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited
unbindSignal<V, S extends ReadonlySignal<V>>(S val) → S
Unbind an existing signal
unlistenSignal(ReadonlySignal target, void callback()) → void
Stop listening to a signal value
unwatchSignal<V, S extends ReadonlySignal<V>>(S val) → V
Unwatch an existing signal
watchSignal<V, S extends ReadonlySignal<V>>(S val) → V
Watch signal value

Operators

operator ==(Object other) → bool
The equality operator.
inherited