popAndPushNamed<T extends Object?, TO extends Object?> method
Pop the current route off the navigator and push a named route in its place.
The popping of the previous route is handled as per pop.
The new route's name will be passed to the Navigator.onGenerateRoute callback. The returned route will be pushed into the navigator.
The new route, the old route, and the route below the old route (if any) are all notified (see Route.didPop, Route.didComplete, Route.didPopNext, Route.didPush, and Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didPop and NavigatorObserver.didPush). The animations for the pop and the push are performed simultaneously, so the route below may be briefly visible even if both the old route and the new route are opaque (see TransitionRoute.opaque).
Ongoing gestures within the current route are canceled when a new route is pushed.
The T type argument is the type of the return value of the new route,
and TO is the return value type of the old route.
To use popAndPushNamed, a Navigator.onGenerateRoute callback must be provided.
Returns a Future that completes to the result value passed to pop
when the pushed route is popped off the navigator.
The provided arguments are passed to the pushed route via
RouteSettings.arguments. Any object can be passed as arguments (e.g. a
String, int, or an instance of a custom MyRouteArguments class).
Often, a Map is used to pass key-value pairs.
The arguments may be used in Navigator.onGenerateRoute or
Navigator.onUnknownRoute to construct the route.
See also:
- restorablePopAndPushNamed, which pushes a new route that can be restored during state restoration.
Implementation
@optionalTypeArgs
Future<T?> popAndPushNamed<T extends Object?, TO extends Object?>(
String routeName, {
TO? result,
Object? arguments,
}) {
pop<TO>(result);
return pushNamed<T>(routeName, arguments: arguments);
}