When a route is removed from the stack, associated futures must complete

When routes are pushed, developers can await them to be notified when they are popped. However, this didn't work when they were removed because the associated future was never completed.

All Navigator methods that call remove had this issue. By using complete, the issue is properly resolved, allowing developers to pass a result.

All Navigator methods have been updated to no longer call remove but instead use complete. Context menus are now built from the contextMenuBuilder parameter.

All methods that directly use complete now accept an optional result parameter to return it to the associated future. Other methods that indirectly use remove currently return null. In the future, we might extend these methods with an optional callback function to allow developers to handle pop logic in indirect scenarios (such as removeUntil).

Before this PR, the methods below can't return a result:

Navigator.of(context).removeRoute(route);
Navigator.of(context).removeRouteBelow(route);

After this PR, methods can return a result:

Navigator.of(context).removeRoute(route, result);
Navigator.of(context).removeRouteBelow(route, result);

If you implemented RouteTransitionRecord and used markForRemove, you need to use markForComplete instead. markForRemove is now deprecated.

For other developers, no changes are required. The navigator continues to work as expected with new capabilities.

Landed in version: 3.31.0-0.0.pre
In stable release: 3.32

• RouteTransitionRecord
• Navigator

• removeRoute unresolved future

• feat: removeRoute now calls didComplete