push<T extends Object?> method

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

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.

The T type argument is the type of the return value of the 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 _openPage() {
  navigator.push<void>(
    MaterialPageRoute<void>(
      builder: (BuildContext context) => const MyPage(),
    ),
  );
}

See also:

  • restorablePush, which pushes a route that can be restored during state restoration.

Implementation

@optionalTypeArgs
Future<T?> push<T extends Object?>(Route<T> route) {
  _pushEntry(_RouteEntry(route, pageBased: false, initialState: _RouteLifecycle.push));
  return route.popped;
}