pushNamedAndRemoveUntil method

Future pushNamedAndRemoveUntil(
  1. String routeName, {
  2. required RoutePredicate predicate,
  3. Object? arguments,
})

Push the route with the given routeName onto the navigator that most tightly encloses the given context.

The arguments parameter is passed to the pushed route.

The predicate is used to determine whether the route is removed. The predicate is called with the pushed route as argument and must return true if the route should be removed, false otherwise.

The return value is the value that the route that was removed was popped with; this route cannot interact with the route below itself, and the return value is null unless the removed route was popped with Navigator.pop (e.g. by pressing the back button on Android).

Implementation

Future<dynamic> pushNamedAndRemoveUntil(
  final String routeName, {
  required final RoutePredicate predicate,
  final Object? arguments,
}) => Navigator.of(
  this,
).pushNamedAndRemoveUntil(routeName, predicate, arguments: arguments);