CoordinatorRecoverable<T extends RouteUri> mixin

Mixin for coordinators that recover navigation state from deep links.

Requires both CoordinatorNavigatable and CoordinatorMutatable. Override strategy behaviour via defineDeeplinkHandler.

Superclass constraints
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
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
defineDeeplinkHandler(DeeplinkStrategy strategy, CoordinatorDeeplinkHandler<T> handler) → void
Registers or overrides the handler for strategy.
defineLayout() → void
Defines the layout structure for this coordinator.
inherited
defineLayoutParentConstructor(Object layoutKey, RouteLayoutParentConstructor<RouteTarget> constructor) → void
Registers a constructor for a layout parent identified by layoutKey.
inherited
dispose() → void
inherited
getLayoutParentConstructor(Object layoutKey) → RouteLayoutParentConstructor<RouteTarget>?
Retrieves the constructor for layoutKey, or null if unregistered.
inherited
init() → void
inherited
markNeedRebuild({NavigationHistoryIntent historyIntent = NavigationHistoryIntent.automatic}) → void
Triggers a rebuild of the coordinator.
inherited
Navigates to a route with smart history handling.
inherited

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and navigates to the resulting route.
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
pop([Object? result]) → Future<void>
Pops from the nearest eligible path with at least two entries.
inherited
prepareParentLayoutList(RouteLayoutParent<RouteTarget> layout, {_ResolveLayoutStrategy strategy = _ResolveLayoutStrategy.override}) → Future<void>
Ensures the layout hierarchy is properly activated for navigation.
inherited
push<R extends Object>(T route) → Future<R?>
Adds a route to the navigation stack.
inherited
pushOrMoveToTop(T route) → Future<void>
Pushes a route to the top, or moves it to top if already in stack.
inherited
pushOrMoveToTopUri(Uri uri) → Future<void>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and pushes the route, or moves it to the top if present.
pushReplacement<R extends Object, RO extends Object>(T route, {RO? result}) → Future<R?>
Replaces the current route with a new one.
inherited
pushReplacementUri<R extends Object, RO extends Object>(Uri uri, {RO? result}) → Future<R?>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and replaces the current route with the resulting route.
pushSilently(T route) → Future<void>
Adds a route and completes once the stack mutation is committed.
inherited
pushSilentlyUri(Uri uri) → Future<void>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and pushes the resulting route without waiting for pop.
pushUri<R extends Object>(Uri uri) → Future<R?>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri, pushes the resulting route, and waits for its result.
recordHistoryIntent(NavigationHistoryIntent intent) → void
Records how the next committed URI should affect external history.
inherited
recover(T route) → Future<void>
Recovers navigation state from a route, respecting RouteDeepLink strategy.
recoverUri(Uri uri) → Future<void>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and recovers it using its deep-link strategy.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from this object's listeners.
inherited
replace(T route) → Future<void>
Clears all paths and sets a single route as the new state.
inherited
replaceUri(Uri uri) → Future<void>

Available on CoordinatorRecoverable<T>, provided by the CoordinatorUriActions extension

Parses uri and replaces the current navigation state with it.
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
tryPop([Object? result]) → Future<bool?>
Attempts to pop from the nearest eligible path.
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