pushReplacementNamed<T extends Object, TO extends Object> method

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

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.

If non-null, result will be used as the result of the route that is removed; the future that had been returned from pushing that old 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 old 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 and the route below the removed route are notified (see Route.didPush and Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didReplace). The removed route is notified once the new route has finished animating (see Route.didComplete). The removed route's exit animation is not run (see popAndPushNamed for a variant that does animated the removed route).

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 type of the return value 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 _switchToBrightness() {
  Navigator.pushReplacementNamed(context, '/settings/brightness');
}

Implementation

@optionalTypeArgs
static Future<T> pushReplacementNamed<T extends Object, TO extends Object>(
  BuildContext context,
  String routeName, {
  TO result,
  Object arguments,
}) {
  return Navigator.of(context).pushReplacementNamed<T, TO>(routeName, arguments: arguments, result: result);
}