replace<T extends Object?> static method

  1. @optionalTypeArgs
void replace<T extends Object?>(
  1. BuildContext context, {
  2. required Route oldRoute,
  3. required Route<T> newRoute,
})

Replaces a route on the navigator that most tightly encloses the given context with a new route.

The old route must not be currently visible, as this method skips the animations and therefore the removal would be jarring if it was visible. To replace the top-most route, consider pushReplacement instead, which does animate the new route, and delays removing the old route until the new route has finished animating.

The removed route is removed without being completed, so this method does not take a return value argument.

The new route, the route below the new route (if any), and the route above the new route, are all notified (see Route.didReplace, Route.didChangeNext, and Route.didChangePrevious). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didReplace). The removed route is disposed without being notified. The future that had been returned from pushing that routes will not complete.

This can be useful in combination with removeRouteBelow when building a non-linear user experience.

The T type argument is the type of the return value of the new route.

See also:

  • replaceRouteBelow, which is the same but identifies the route to be removed by reference to the route above it, rather than directly.
  • restorableReplace, which adds a replacement route that can be restored during state restoration.

Implementation

@optionalTypeArgs
static void replace<T extends Object?>(BuildContext context, { required Route<dynamic> oldRoute, required Route<T> newRoute }) {
  return Navigator.of(context).replace<T>(oldRoute: oldRoute, newRoute: newRoute);
}