ZenScopeWidget class

Widget-scoped dependency injection provider

ZenScopeWidget provides a ZenScope to its descendants via InheritedWidget. It's the foundational widget for hierarchical dependency injection in Zenify.

Architecture:

  • Automatic parent scope discovery from widget tree
  • Supports both direct scope provision and module-based creation
  • Clean lifecycle management (widget disposal = scope disposal)
  • No global state - pure widget tree-based

Usage patterns:

Pattern 1: Provide an existing scope

final myScope = ZenScope(name: 'MyScope');
myScope.put<MyService>(MyService());

ZenScopeWidget(
  scope: myScope,
  child: MyWidget(),
)

Pattern 2: Create scope from module

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

The scope is automatically disposed when this widget is removed from the tree (only if created by this widget, not if provided externally).

Inheritance

Constructors

ZenScopeWidget({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.