NavigatorStateMethodsMixin mixin

Supply the Global Navigator and all its methods.

Mixin applications

Properties

hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

canPop() bool
Whether the navigator can be popped.
finalizeRoute(Route route) → void
Complete the lifecycle for a route that has been popped off the navigator.
maybePop<T extends Object?>([T? result]) Future<bool>
Consults the current route's Route.popDisposition method, and acts accordingly, potentially popping the route as a result; returns whether the pop request should be considered handled.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pop<T extends Object?>([T? result]) → void
Pop the top-most route off the navigator.
popAndPushNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) Future<T?>
Pop the current route off the navigator and push a named route in its place.
popUntil(RoutePredicate predicate) → void
Calls pop repeatedly until the predicate returns true.
push<T extends Object?>(Route<T> route) Future<T?>
Push the given route onto the navigator.
pushAndRemoveUntil<T extends Object?>(Route<T> newRoute, RoutePredicate predicate) Future<T?>
Push the given route onto the navigator, and then remove all the previous routes until the predicate returns true.
pushNamed<T extends Object?>(String routeName, {Object? arguments}) Future<T?>
Push a named route onto the navigator.
pushNamedAndRemoveUntil<T extends Object?>(String newRouteName, RoutePredicate predicate, {Object? arguments}) Future<T?>
Push the route with the given name onto the navigator, and then remove all the previous routes until the predicate returns true.
pushReplacement<T extends Object?, TO extends Object?>(Route<T> newRoute, {TO? result}) Future<T?>
Replace the current route of the navigator by pushing the given route and then disposing the previous route once the new route has finished animating in.
pushReplacementNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) Future<T?>
Replace the current route of the navigator by pushing the route named routeName and then disposing the previous route once the new route has finished animating in.
removeRoute(Route route) → void
Immediately remove route from the navigator, and Route.dispose it.
removeRouteBelow(Route anchorRoute) → void
Immediately remove a route from the navigator, and Route.dispose it. The route to be removed is the one below the given anchorRoute.
replace<T extends Object?>({required Route oldRoute, required Route<T> newRoute}) → void
Replaces a route on the navigator that most tightly encloses the given context with a new route.
replaceRouteBelow<T extends Object?>({required Route anchorRoute, required Route<T> newRoute}) → void
Replaces a route on the navigator with a new route. The route to be replaced is the one below the given anchorRoute.
restorablePopAndPushNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) String
Pop the current route off the navigator and push a named route in its place.
restorablePush<T extends Object?>(RestorableRouteBuilder<T> routeBuilder, {Object? arguments}) String
Push a new route onto the navigator.
restorablePushAndRemoveUntil<T extends Object?>(RestorableRouteBuilder<T> newRouteBuilder, RoutePredicate predicate, {Object? arguments}) String
Push a new route onto the navigator, and then remove all the previous routes until the predicate returns true.
restorablePushNamed<T extends Object?>(String routeName, {Object? arguments}) String
Push a named route onto the navigator.
restorablePushNamedAndRemoveUntil<T extends Object?>(String newRouteName, RoutePredicate predicate, {Object? arguments}) String
Push the route with the given name onto the navigator that most tightly encloses the given context, and then remove all the previous routes until the predicate returns true.
restorablePushReplacement<T extends Object?, TO extends Object?>(RestorableRouteBuilder<T> routeBuilder, {TO? result, Object? arguments}) String
Replace the current route of the navigator by pushing a new route and then disposing the previous route once the new route has finished animating in.
restorablePushReplacementNamed<T extends Object?, TO extends Object?>(String routeName, {TO? result, Object? arguments}) String
Replace the current route of the navigator that most tightly encloses the given context by pushing the route named routeName and then disposing the previous route once the new route has finished animating in.
restorableReplace<T extends Object?>({required Route oldRoute, required RestorableRouteBuilder<T> newRouteBuilder, Object? arguments}) String
Replaces a route on the navigator that most tightly encloses the given context with a new route.
restorableReplaceRouteBelow<T extends Object?>({required Route anchorRoute, required RestorableRouteBuilder<T> newRouteBuilder, Object? arguments}) String
Replaces a route on the navigator with a new route. The route to be replaced is the one below the given anchorRoute.
toString() String
A string representation of this object.
inherited

Operators

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