ModularityRoot#

class ModularityRoot

Root widget for the Modularity framework.

Provides DI configuration, a shared ModuleRetainer, a global module registry, and lifecycle management to the entire widget subtree. Must be placed above all ModuleScope widgets in the tree.

Usage#

final observer = RouteObserver<ModalRoute<dynamic>>();

ModularityRoot(
  observer: observer,
  interceptors: [TimingInterceptor()],
  lifecycleLogger: kDebugMode ? ModularityRoot.defaultDebugLogger : null,
  child: MaterialApp(
    navigatorObservers: [observer],
    home: const HomePage(),
  ),
)

Constructors#

ModularityRoot() const#

const ModularityRoot({ dynamic key, required dynamic child, dynamic binderFactory, dynamic defaultLoadingBuilder, dynamic Function(dynamic, Object? error, dynamic retry)? defaultErrorBuilder, dynamic observer, List<dynamic>? interceptors, void Function(ModuleLifecycleEvent event, Type moduleType, { Map<String, Object?>? details, Object? retentionKey})? lifecycleLogger, ModuleRetainer? retainer, })

Create the root widget that provides DI configuration and a shared ModuleRetainer to the widget subtree.

Implementation

const ModularityRoot({
  super.key,
  required this.child,
  this.binderFactory,
  this.defaultLoadingBuilder,
  this.defaultErrorBuilder,
  this.observer,
  this.interceptors,
  this.lifecycleLogger,
  this.retainer,
});

Properties#

binderFactory final#

final dynamic binderFactory

Factory used to create Binder instances for each ModuleScope.

Defaults to SimpleBinderFactory when not provided.

Implementation

final BinderFactory? binderFactory;

child final#

final dynamic child

Widget subtree that receives the modularity configuration.

Implementation

final Widget child;

defaultErrorBuilder final#

final dynamic Function(dynamic, Object? error, dynamic retry)? defaultErrorBuilder

Optional builder for the default error widget shown by ModuleScope when module initialization fails.

Implementation

final Widget Function(BuildContext, Object? error, VoidCallback retry)?
defaultErrorBuilder;

defaultLoadingBuilder final#

final dynamic defaultLoadingBuilder

Optional builder for the default loading widget shown by ModuleScope while a module is initializing.

Implementation

final WidgetBuilder? defaultLoadingBuilder;

hashCode no setter inherited#

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

interceptors final#

final List<dynamic>? interceptors

Global list of ModuleInterceptors applied to all modules.

Implementation

final List<ModuleInterceptor>? interceptors;

lifecycleLogger final#

final void Function(ModuleLifecycleEvent event, Type moduleType, { Map<String, Object?>? details, Object? retentionKey})? lifecycleLogger

Optional logger for module lifecycle events.

When set, receives callbacks for module creation/reuse, retention cache register/release/evict, and route termination handling.

Implementation

final ModuleLifecycleLogger? lifecycleLogger;

observer final#

final dynamic observer

RouteObserver for route-bound and keep-alive retention policies.

When provided, pass the same observer to MaterialApp.navigatorObservers so that route lifecycle events are forwarded to the framework.

When omitted, a default observer is created internally with a debug warning that route-bound retention will not work unless the observer is also registered in the navigator.

Implementation

final RouteObserver<ModalRoute<dynamic>>? observer;

retainer final#

final ModuleRetainer? retainer

Shared ModuleRetainer that caches ModuleController instances across scopes using the ModuleRetentionPolicy.keepAlive policy.

Implementation

final ModuleRetainer? retainer;

runtimeType no setter inherited#

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

Methods#

createState()#

dynamic createState()

Implementation

@override
State<ModularityRoot> createState() => _ModularityRootState();

noSuchMethod() inherited#

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Object.

Implementation

external String toString();

Operators#

operator ==() inherited#

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

Total: It must return a boolean for all arguments. It should never throw.
Reflexive: For all objects o, o == o must be true.
Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.
Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);

Static Methods#

binderFactoryOf()#

dynamic binderFactoryOf(dynamic context)

Return the BinderFactory from the nearest ModularityRoot.

Implementation

static BinderFactory binderFactoryOf(BuildContext context) =>
    _of(context).binderFactory;

defaultErrorBuilderOf()#

dynamic Function(dynamic, Object? error, dynamic retry)? defaultErrorBuilderOf(dynamic context);

Return the default error builder from the nearest ModularityRoot, or null if none was configured.

Implementation

static Widget Function(BuildContext, Object?, VoidCallback)?
defaultErrorBuilderOf(BuildContext context) =>
    _of(context).defaultErrorBuilder;

defaultLoadingBuilderOf()#

dynamic defaultLoadingBuilderOf(dynamic context)

Return the default loading builder from the nearest ModularityRoot, or null if none was configured.

Implementation

static WidgetBuilder? defaultLoadingBuilderOf(BuildContext context) =>
    _of(context).defaultLoadingBuilder;

interceptorsOf()#

List<dynamic> interceptorsOf(dynamic context)

Return the list of ModuleInterceptors from the nearest ModularityRoot.

Implementation

static List<ModuleInterceptor> interceptorsOf(BuildContext context) =>
    _of(context).interceptors;

log()#

void log( dynamic context, ModuleLifecycleEvent event, Type moduleType, { Object? retentionKey, Map<String, Object?>? details, });

Log a lifecycle event via the logger from the nearest ModularityRoot.

Does nothing if no lifecycleLogger is configured.

Implementation

static void log(
  BuildContext context,
  ModuleLifecycleEvent event,
  Type moduleType, {
  Object? retentionKey,
  Map<String, Object?>? details,
}) {
  _of(context).lifecycleLogger?.call(
    event,
    moduleType,
    retentionKey: retentionKey,
    details: details,
  );
}

observerOf()#

dynamic observerOf(dynamic context)

Return the RouteObserver from the nearest ModularityRoot.

Implementation

static RouteObserver<ModalRoute<dynamic>> observerOf(BuildContext context) =>
    _of(context).observer;

registryOf()#

Map<dynamic, dynamic> registryOf(dynamic context)

Return the global module registry from the nearest ModularityRoot.

Implementation

static Map<ModuleRegistryKey, ModuleController> registryOf(
  BuildContext context,
) => _of(context).registry;

retainerOf()#

ModuleRetainer retainerOf(dynamic context)

Return the shared ModuleRetainer from the nearest ModularityRoot.

Implementation

static ModuleRetainer retainerOf(BuildContext context) =>
    _of(context).retainer;

Constants#

defaultDebugLogger#

const void Function(ModuleLifecycleEvent event, Type moduleType, { Map<String, Object?>? details, Object? retentionKey}) defaultDebugLogger

Default debug logger that prints lifecycle events via debugPrint.

Implementation

static const ModuleLifecycleLogger defaultDebugLogger = _defaultDebugLogger;