CoordinatorLayout<T extends RouteUnique> mixin

Mixin that provides Flutter layout builders for Coordinator.

Layout-parent registration and hierarchy activation live in CoordinatorLayoutCore (zenrouter_core). This mixin only owns the widget builder table used by NavigationStack / IndexedStackPathBuilder.

Superclass constraints
Implemented types
Mixin applications
Available extensions

Properties

activeLayoutParent → RouteLayoutParent<RouteTarget>?
Returns the deepest active RouteLayout in the navigation hierarchy.
no setterinherited
activeLayoutParentList → List<RouteLayoutParent<RouteTarget>>
Returns all active RouteLayout instances in the navigation hierarchy.
no setterinherited
activePath → StackPath<T>
Returns the currently active StackPath.
no setterinherited
activePaths → List<StackPath<RouteTarget>>
no setterinherited
coordinator → CoordinatorModular<T>
no setterinherited
currentUri → Uri
Returns the current URI based on the active route.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
initialRoutePath → Uri?
The initial route path for this coordinator.
finalinherited
isInNavigationTransaction → bool
Whether a navigation transaction is currently running for this coordinator.
no setterinherited
isRouteModule → bool
Whether this coordinator is a part of a CoordinatorModular.
latefinalinherited
lastNavigationCommit → NavigationCommit?
The most recently published atomic navigation commit.
no setterinherited
layoutBuilderTable → Map<PathKey, RouteLayoutBuilder<RouteUnique>>
latefinal
layoutParentConstructorTable → Map<Object, RouteLayoutParentConstructor<RouteTarget>>
latefinalinherited
paths → List<StackPath<RouteTarget>>
All navigation paths managed by this coordinator.
no setterinherited
props → List<Object?>
User-defined properties for equality comparison.
no setterinherited
root → StackPath<T>
The root (primary) navigation path.
no setterinherited
rootCoordinator → CoordinatorCore<T>
The rootCoordinator coordinator return a top level coordinator which used as routeConfig.
latefinalinherited
routeManifest → RouteManifest<Object>
Static route topology exposed to tooling and routing adapters.
no setterinherited
routeManifestFragment → RouteManifestFragment<Object>
Declarative topology contributed to an owning modular coordinator.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when this object notifies its listeners.
inherited
compareWith(Object other) → bool
Compares this object with another for equality.
inherited
consumeHistoryIntent() → NavigationHistoryIntent
Returns and clears the history intent for the next URI report.
inherited
createLayoutParent(Object layoutKey) → RouteLayoutParent<RouteTarget>?
Creates a layout parent via the registered constructor for layoutKey.
inherited
defineConverter() → void
Defines the restorable converters for this coordinator.
inherited
defineLayout() → void
Defines the layout structure for this coordinator.
inherited
defineLayoutBuilder(PathKey key, RouteLayoutBuilder<RouteUnique> builder) → void
Registers a layout builder for a specific PathKey.
defineLayoutParentConstructor(Object layoutKey, RouteLayoutParentConstructor<RouteTarget> constructor) → void
Registers a constructor for a layout parent identified by layoutKey.
inherited
dispose() → void
override
getLayoutBuilder(PathKey key) → RouteLayoutBuilder<RouteUnique>?
Retrieves the layout builder registered for a specific PathKey.
getLayoutParentConstructor(Object layoutKey) → RouteLayoutParentConstructor<RouteTarget>?
Retrieves the constructor for layoutKey, or null if unregistered.
inherited
init() → void
inherited
layoutBuilder(BuildContext context) → Widget
Builds the root widget (the primary navigator).
override
markNeedRebuild({NavigationHistoryIntent historyIntent = NavigationHistoryIntent.automatic}) → void
Triggers a rebuild of the coordinator.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
inherited
parseRouteFromUri(Uri uri) → FutureOr<T?>
Parses a Uri into a route object.
inherited
prepareParentLayoutList(RouteLayoutParent<RouteTarget> layout, {_ResolveLayoutStrategy strategy = _ResolveLayoutStrategy.override}) → Future<void>
Ensures the layout hierarchy is properly activated for navigation.
inherited
recordHistoryIntent(NavigationHistoryIntent intent) → void
Records how the next committed URI should affect external history.
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from this object's listeners.
inherited
resolveRoute(RouteRequest request) → Future<RouteResolution<T>>
Resolves a request into an adapter-neutral routing outcome.
inherited
runNavigationTransaction<R>(FutureOr<R> operation(), {NavigationHistoryIntent historyIntent = NavigationHistoryIntent.automatic}) → Future<R>
Runs path mutations as one coordinator-level navigation commit.
inherited
toFlutterListenable() → Listenable

Available on ListenableMixin, provided by the ListenableMixinToFlutterListenable extension

Wraps this mixin as a Flutter flutter.Listenable for ListenableBuilder / AnimatedBuilder.
toString() → String
A string representation of this object.
inherited
withHistoryIntent<R>(NavigationHistoryIntent intent, FutureOr<R> operation()) → Future<R>
Runs operation with a history intent that inner stack mutations cannot override.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited