popAndPushNamed<T extends Object, TO extends Object> method

  1. @optionalTypeArgs
Future<T> popAndPushNamed <T extends Object, TO extends Object>(String routeName, { TO result, Object arguments })
@optionalTypeArgs

Pop the current route off the navigator and push a named route in its place.

If non-null, result will be used as the result of the route that is popped; the future that had been returned from pushing the popped route will complete with result. Routes such as dialogs or popup menus typically use this mechanism to return the value selected by the user to the widget that created their route. The type of result, if provided, must match the type argument of the class of the popped route (TO).

The route name will be passed to the navigator's 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 NavigatorObservers.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.

Returns a Future that completes to the result value passed to pop when the pushed route is popped off the navigator.

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.

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.

Typical usage is as follows:
void _begin() {
  navigator.popAndPushNamed('/nyc/1776');
}

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);
}