push<T extends Object> method

  1. @optionalTypeArgs
Future<T> push <T extends Object>(Route<T> route)
@optionalTypeArgs

Push the given route onto the navigator.

The new route and the previous route (if any) are notified (see Route.didPush and Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didPush).

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 route.

Typical usage is as follows:
void _openPage() {
  navigator.push(MaterialPageRoute(builder: (BuildContext context) => MyPage()));
}

Implementation

@optionalTypeArgs
Future<T> push<T extends Object>(Route<T> route) {
  assert(!_debugLocked);
  assert(() { _debugLocked = true; return true; }());
  assert(route != null);
  assert(route._navigator == null);
  final Route<dynamic> oldRoute = _history.isNotEmpty ? _history.last : null;
  route._navigator = this;
  route.install(_currentOverlayEntry);
  _history.add(route);
  route.didPush();
  route.didChangeNext(null);
  if (oldRoute != null) {
    oldRoute.didChangeNext(route);
    route.didChangePrevious(oldRoute);
  }
  for (NavigatorObserver observer in widget.observers)
    observer.didPush(route, oldRoute);
  assert(() { _debugLocked = false; return true; }());
  _afterNavigation(route);
  return route.popped;
}