SignalScope class

An InheritedWidget that provides a registry of signal or computed overrides to a widget subtree.

This is highly useful for dependency injection, decoupling states from widgets, and overriding states during testing and mocking.

Inheritance

• Object
• DiagnosticableTree
• Widget
• ProxyWidget
• InheritedWidget
• SignalScope

Constructors

SignalScope({Key? key, required Map<Node, Node> overrides, required Widget child})

Creates a SignalScope with the given overrides and a child widget.

const

Properties

child → Widget

The widget below this widget in the tree.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

overrides → Map<Node, Node>

Map of original nodes to their overridden counterparts.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → InheritedElement

Inflates this configuration to a concrete instance.

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

updateShouldNotify(covariant SignalScope oldWidget) → bool

Whether the framework should notify widgets that inherit from this widget.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get<N extends Node>(BuildContext context, N original) → N

Resolves the given original node.

maybeOf(BuildContext context) → SignalScope?

Looks up the nearest SignalScope ancestor.