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

• State<T>

Properties

context → BuildContext

The location in the tree where this widget builds.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

mounted → bool

Whether this State object is currently in a tree.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

widget → T

The current configuration.

no setter, inherited

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

createAsyncSignal<S>(AsyncState<S> value, {String? debugLabel}) → AsyncSignal<S>

Create a signal holding an async value

createComputed<V>(V cb(), {String? debugLabel}) → Computed<V>

Create a computed

createComputedAsync<S>(Future<S> fn(), {S? initialValue, String? debugLabel, List<ReadonlySignal> dependencies = const [], bool lazy = true}) → FutureSignal<S>

Async Computed is syntax sugar around FutureSignal.

createComputedFrom<S, A>(List<ReadonlySignal<A>> signals, Future<S> fn(List<A> args), {S? initialValue, String? debugLabel, bool lazy = true}) → FutureSignal<S>

Async Computed is syntax sugar around FutureSignal.

createEffect(dynamic cb(), {String? debugLabel, dynamic onDispose()?}) → EffectCleanup

Create a effect.

createFutureSignal<S>(Future<S> fn(), {S? initialValue, String? debugLabel, List<ReadonlySignal> dependencies = const [], bool lazy = true}) → FutureSignal<S>

Create a signal from a future

createListSignal<V>(List<V> list, {String? debugLabel}) → ListSignal<V>

Create a ListSignal

createMapSignal<K, V>(Map<K, V> value, {String? debugLabel}) → MapSignal<K, V>

Create a MapSignal

createQueueSignal<V>(Queue<V> queue, {String? debugLabel}) → QueueSignal<V>

Create a QueueSignal

createSetSignal<V>(Set<V> set, {String? debugLabel}) → SetSignal<V>

Create a SetSignal

createSignal<V>(V val, {String? debugLabel}) → Signal<V>

Create a signal

createStreamSignal<S>(Stream<S> callback(), {S? initialValue, String? debugLabel, List<ReadonlySignal> dependencies = const [], void onDone()?, bool? cancelOnError, bool lazy = true}) → StreamSignal<S>

Create a signals from a stream

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