ZenScopeWidget class

A widget that provides a ZenScope to its descendants.

This widget makes a ZenScope available to its subtree, allowing descendant widgets to access controllers and services registered in that scope.

There are two ways to use this widget:

  1. Provide an existing scope using the scope parameter
  2. Create a new scope from a module using the moduleBuilder parameter

Example using an existing scope:

ZenScopeWidget(
  scope: ZenScope(name: 'MyScope'),
  child: MyWidget(),
)

Example using a module:

ZenScopeWidget(
  moduleBuilder: () => MyFeatureModule(),
  scopeName: 'FeatureScope',
  child: MyFeatureScreen(),
)
Inheritance

Constructors

ZenScopeWidget.new({Key? key, required Widget child, ZenScope? scope, ZenModule moduleBuilder()?, String? scopeName})
Creates a ZenScopeWidget that provides a scope to its descendants.
const

Properties

child → Widget
The child widget to which the scope will be provided.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
moduleBuilder → ZenModule Function()?
A function that creates a module to be registered in a new scope. Use this for feature modules with dependencies.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scope → ZenScope?
An existing scope to provide to descendants. Use this when you already have a scope instance.
final
scopeName → String?
Optional name for the scope when creating one via moduleBuilder. Defaults to the module name if not provided.
final

Methods

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

maybeOf(BuildContext context) → ZenScope?
Finds the nearest ZenScope above the given context.
of(BuildContext context) → ZenScope
Finds the nearest ZenScope above the given context.