scopo library

A set of tools for creating and managing scopes on Flutter. Including dependency injection, asynchronous initialization and disposal.

Classes

AsyncDataScope<T extends Object?>

AsyncDataScopeBase<W extends AsyncDataScopeBase<W, T>, T extends Object?>

AsyncDataScopeContext<W extends ScopeInheritedWidget, T extends Object?>

AsyncDataScopeCore<W extends AsyncDataScopeCore<W, E, T>, E extends AsyncDataScopeElementBase<W, E, T>, T extends Object?>

AsyncDataScopeElementBase<W extends AsyncDataScopeCore<W, E, T>, E extends AsyncDataScopeElementBase<W, E, T>, T extends Object?>

AsyncDataScopeInitState<P extends Object, T extends Object?>

AsyncDataScopeProgress<P extends Object, T extends Object?>

AsyncDataScopeReady<P extends Object, T extends Object?>

AsyncScope

AsyncScopeBase<W extends AsyncScopeBase<W>>

AsyncScopeContext<W extends ScopeInheritedWidget>

AsyncScopeCoordinator

AsyncScopeCoordinatorEntry

AsyncScopeCore<W extends AsyncScopeCore<W, E>, E extends AsyncScopeElementBase<W, E>>

AsyncScopeElementBase<W extends AsyncScopeCore<W, E>, E extends AsyncScopeElementBase<W, E>>

AsyncScopeError

AsyncScopeInitState

AsyncScopeProgress

AsyncScopeReady

AsyncScopeRoot

AsyncScopeState

AsyncScopeWaiting

CompareUtils

CompositeListenableSubscription

Acts as a container for multiple subscriptions ListenableSubscription that can be canceled at once.

DepHelper

ListenableSelector<L extends Listenable, T extends Object?>

A widget that rebuilds when a value selected from a Listenable changes.

ListenableSelectSubscription<T extends Object?>

A subscription on selected value changes from a Listenable.

ListenableSubscription

A subscription on changes from a Listenable.

ListenableView<T extends Listenable>

LiteScope<W extends LiteScope<W, S>, S extends LiteScopeState<W, S>>

A base class for creating lite scopes without dependency management payload.

LiteScopeCore<W extends LiteScopeCore<W, E, S>, E extends LiteScopeElementBase<W, E, S>, S extends LiteScopeCoreState<W, E, S>>

A core abstract class for lite scopes, providing minimal dependency injection and state management.

LiteScopeCoreState<W extends LiteScopeCore<W, E, S>, E extends LiteScopeElementBase<W, E, S>, S extends LiteScopeCoreState<W, E, S>>

The core state base class for LiteScopeCore.

LiteScopeElementBase<W extends LiteScopeCore<W, E, S>, E extends LiteScopeElementBase<W, E, S>, S extends LiteScopeCoreState<W, E, S>>

The core element base class for LiteScopeCore.

LiteScopeInitState

Represents the initialization state of a LiteScope.

LiteScopeProgress

Represents the progress state during the initialization of a LiteScope.

LiteScopeReady

Represents the ready state of a LiteScope when initialization is complete.

LiteScopeState<W extends LiteScope<W, S>, S extends LiteScopeState<W, S>>

The state implementation for LiteScope.

LiteScopeWaiting

Represents the wait state before initialization starts.

NavigationNode

Navigation node.

Progress

ProgressIterator

A helper class to track initialization progress as an Progress value.

Scope<W extends Scope<W, D, S>, D extends ScopeDependencies, S extends ScopeState<W, D, S>>

A base class for creating scopes with dependency injection and state management.

ScopeAutoDependencies<T extends ScopeDependencies, C extends Object?>

ScopeAutoDependenciesProgress

ScopeChildEntry

ScopeConfig

ScopeContext<W extends ScopeInheritedWidget>

ScopeCore<W extends ScopeCore<W, E, D, S>, E extends ScopeElementBase<W, E, D, S>, D extends ScopeDependencies, S extends ScopeCoreState<W, E, D, S>>

A core abstract class for scopes, bridging dependency injection with state management.

ScopeCoreState<W extends ScopeCore<W, E, D, S>, E extends ScopeElementBase<W, E, D, S>, D extends ScopeDependencies, S extends ScopeCoreState<W, E, D, S>>

The core state base class for ScopeCore.

ScopeDependencies

A container for dependencies (e.g., repositories, services).

ScopeDependency

ScopeDependencyCancelled

ScopeDependencyCancelledStates

ScopeDependencyDisposalCancelled

ScopeDependencyDisposalFailed

ScopeDependencyDisposed

ScopeDependencyFailed

ScopeDependencyFailedStates

ScopeDependencyGroup

ScopeDependencyInfo

ScopeDependencyInitial

ScopeDependencyInitialized

ScopeDependencyNoDisposalRequred

ScopeDependencyState

ScopeDependencySuccessStates

ScopeElementBase<W extends ScopeCore<W, E, D, S>, E extends ScopeElementBase<W, E, D, S>, D extends ScopeDependencies, S extends ScopeCoreState<W, E, D, S>>

The core element base class for ScopeCore.

ScopeInheritedElement<W extends ScopeInheritedWidget>

ScopeInheritedWidget

ScopeInitState<P extends Object, D extends ScopeDependencies>

Represents the initialization state of a Scope.

ScopeLevelLogger

ScopeLog

ScopeLogger

ScopeLogLevel

ScopeModel<M extends Object>

ScopeModelBase<W extends ScopeModelBase<W, M>, M extends Object>

ScopeModelContext<W extends ScopeInheritedWidget, M extends Object>

ScopeModelCore<W extends ScopeModelCore<W, E, M>, E extends ScopeModelElementBase<W, E, M>, M extends Object>

ScopeModelElementBase<W extends ScopeModelCore<W, E, M>, E extends ScopeModelElementBase<W, E, M>, M extends Object>

ScopeModelInheritedElement<W extends ScopeInheritedWidget, M extends Object>

ScopeNotifier<M extends Listenable>

ScopeNotifierBase<W extends ScopeNotifierBase<W, M>, M extends Listenable>

ScopeNotifierCore<W extends ScopeNotifierCore<W, E, M>, E extends ScopeNotifierElementBase<W, E, M>, M extends Listenable>

ScopeNotifierElementBase<W extends ScopeModelCore<W, E, M>, E extends ScopeNotifierElementBase<W, E, M>, M extends Listenable>

ScopeProgress<P extends Object, D extends ScopeDependencies>

Represents the progress state during the initialization of a Scope.

ScopeReady<P extends Object, D extends ScopeDependencies>

Represents the ready state of a Scope when initialization is complete.

ScopeState<W extends Scope<W, D, S>, D extends ScopeDependencies, S extends ScopeState<W, D, S>>

The state implementation for Scope.

ScopeStateModel<S extends Object>

ScopeStateModelView<S extends Object>

ScopeStateNotifier<S extends Object>

ScopeStateWithErrorModel<S extends Object>

ScopeStateWithErrorModelView<S extends Object>

ScopeStateWithErrorNotifier<S extends Object>

ScopeWidgetBase<W extends ScopeWidgetBase<W>>

ScopeWidgetCore<W extends ScopeWidgetCore<W, E>, E extends ScopeWidgetElementBase<W, E>>

ScopeWidgetElementBase<W extends ScopeWidgetCore<W, E>, E extends ScopeWidgetElementBase<W, E>>

ScreenshotReplacer

A widget that renders its child once, captures a screenshot of it, and then replaces the child with the captured image.

Mixins

AsyncScopeParent

ScopeDependencyMixin

StateAsNotifier<T extends StatefulWidget>

Extensions

IsBuildingExtension on SchedulerBinding

ListenableListenExtension on Listenable

A helper extension that adds a listen method to Listenable, similar to Stream.listen. It returns a ListenableSubscription that can be easily canceled.

ListenableSelectExtension on L

A helper extension that adds a select method to Listenable. It allows listening to a specific value of the Listenable (selector), triggering the listener only when that value changes.

PreviousNavigatorExtension on NavigatorState

ScopeDependenciesExtension on ScopeDependencies

Extension on ScopeDependencies to provide streaming capabilities.

ScopeDependencyExtension on ScopeDependency

Properties

asyncScopeRoot → AsyncScopeRoot

final

Typedefs

ScopeAutoDependenciesStream<T extends ScopeDependencies> = Stream<ScopeInitState<ScopeAutoDependenciesProgress, T>>

ScopeErrorBuilder<P extends Object> = Widget Function(BuildContext context, Object error, StackTrace stackTrace, P? progress)

A builder function used to display an error widget if scope initialization fails.

ScopeInitBuilder<P extends Object> = Widget Function(BuildContext context, P? progress)

A builder function used to display a widget while the Scope is initializing dependencies.

ScopeInitFunction<P extends Object, D extends ScopeDependencies> = Stream<ScopeInitState<P, D>> Function(BuildContext context)

A function that initializes scope dependencies and yields ScopeInitState updates.

ScopeLogFn = bool Function(Object? message, {Object? error, StackTrace? stackTrace})

ScopeLogFormatter<Out extends Object?> = CustomLogFormatter<ScopeLog, Out>

ScopeLogPublisher = CustomLogPublisher<ScopeLog>

ScopeWaitingBuilder = Widget? Function(BuildContext context)

A builder function used to display a waiting widget while the Scope is waiting for a Scope.scopeKey and Scope.initDependencies to send their first state.

Exceptions / Errors

ScopeDependencyException