pushNamedAndRemoveUntil<
- @optionalTypeArgs
Push the route with the given name onto the navigator that most tightly
encloses the given context, 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 new route's name (routeName) 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 bottommost removed route (which
becomes the route below the new route) are notified (see Route.didPush
and Route.didChangeNext). If the Navigator has any
Navigator.observers, they will be notified as well (see
NavigatorObservers.didPush and NavigatorObservers.didRemove). The
removed routes are disposed, without being 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.
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.
void _resetToCalendar() {
Navigator.pushNamedAndRemoveUntil(context, '/calendar', ModalRoute.withName('/'));
}Implementation
@optionalTypeArgs
static Future<T> pushNamedAndRemoveUntil<T extends Object>(BuildContext context, String newRouteName, RoutePredicate predicate) {
return Navigator.of(context).pushNamedAndRemoveUntil<T>(newRouteName, predicate);
}