restorablePopAndPushNamed<T extends Object?, TO extends Object?> method Null safety

  1. @optionalTypeArgs
String restorablePopAndPushNamed<T extends Object?, TO extends Object?>(
  1. BuildContext context,
  2. String routeName,
  3. {TO? result,
  4. Object? arguments}
)

Pop the current route off the navigator that most tightly encloses the given context and push a named route in its place.

Unlike Routes pushed via popAndPushNamed, Routes pushed with this method are restored during state restoration according to the rules outlined in the "State Restoration" section of Navigator.

The popping of the previous route is handled as per pop.

The new route's name will be passed to the Navigator.onGenerateRoute callback. The returned route will be pushed into the navigator.

The new route, the old route, and the route below the old route (if any) are all notified (see Route.didPop, Route.didComplete, Route.didPopNext, Route.didPush, and Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didPop and NavigatorObserver.didPush). The animations for the pop and the push are performed simultaneously, so the route below may be briefly visible even if both the old route and the new route are opaque (see TransitionRoute.opaque).

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, and TO is the return value type of the old route.

To use popAndPushNamed, a Navigator.onGenerateRoute callback must be provided.

The provided arguments are passed to the pushed route via RouteSettings.arguments. Any object that is serializable via the StandardMessageCodec can be passed as arguments. Often, a Map is used to pass key-value pairs.

The arguments may be used in Navigator.onGenerateRoute or Navigator.onUnknownRoute to construct the route.

The method returns an opaque ID for the pushed route that can be used by the RestorableRouteFuture to gain access to the actual Route object added to the navigator and its return value. You can ignore the return value of this method, if you do not care about the route object or the route's return value.

Typical usage is as follows:
void _selectNetwork() {
  Navigator.restorablePopAndPushNamed(context, '/settings/network');
}

Implementation

@optionalTypeArgs
static String restorablePopAndPushNamed<T extends Object?, TO extends Object?>(
  BuildContext context,
  String routeName, {
  TO? result,
  Object? arguments,
}) {
  return Navigator.of(context).restorablePopAndPushNamed<T, TO>(routeName, arguments: arguments, result: result);
}