pushAndRemoveUntil<T extends Object?> method

  1. @optionalTypeArgs
Future<T?> pushAndRemoveUntil<T extends Object?>(
  1. Route<T> newRoute,
  2. RoutePredicate predicate
)

Push the given route onto the navigator, and then remove all the previous routes until the predicate returns true.

The predicate may be applied to the same route more than once if Route.willHandlePopInternally is true.

To remove routes until a route with a certain name, use the RoutePredicate returned from ModalRoute.withName.

To remove all the routes below the pushed route, use a RoutePredicate that always returns false (e.g. (Route<dynamic> route) => false).

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

The newly pushed route and its preceding route are notified for Route.didPush. After removal, the new route and its new preceding route, (the route below the bottommost removed route) are notified through Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didPush and NavigatorObserver.didRemove). The removed routes are disposed of and notified, once the new route has finished animating. The futures that had been returned from pushing those routes will not complete.

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.

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

Typical usage is as follows:
link 
void _resetAndOpenPage() {
  navigator.pushAndRemoveUntil<void>(
    MaterialPageRoute<void>(builder: (BuildContext context) => const MyHomePage()),
    ModalRoute.withName('/'),
  );
}

See also:

Implementation

@optionalTypeArgs
Future<T?> pushAndRemoveUntil<T extends Object?>(Route<T> newRoute, RoutePredicate predicate) {
  assert(newRoute._navigator == null);
  assert(newRoute.overlayEntries.isEmpty);
  _pushEntryAndRemoveUntil(_RouteEntry(newRoute, pageBased: false, initialState: _RouteLifecycle.push), predicate);
  return newRoute.popped;
}