AppRouteNavigation extension

Extension on NavigatorState that adds type-safe navigation methods using SafeRoute.

These methods are thin wrappers around the regular Flutter navigation API (pushNamed, popAndPushNamed, etc.), but enforce correct argument/result types at compile time.

on

Methods

maybePopRoute<TResult, TRoute extends SafeRoute<Object?, TResult>>(TRoute route, {TResult? result}) → Future<bool>

Available on NavigatorState, provided by the AppRouteNavigation extension

Pops the current route if possible.
popAndPushRoute<TArgs, TResult, TPopResult, TRoute extends SafeRoute<TArgs, TResult>>(SafeRoute<TArgs, TResult> route, {TPopResult? result, TArgs? arguments}) → Future<TResult?>

Available on NavigatorState, provided by the AppRouteNavigation extension

Pops the current route and pushes a new one.
popRoute<TResult, TRoute extends SafeRoute<Object?, TResult>>(TRoute route, {TResult? result}) → void

Available on NavigatorState, provided by the AppRouteNavigation extension

Pops the current route.
pushReplacementRoute<TArgs, TResult, TPopResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, {TPopResult? result, TArgs? arguments}) → Future<TResult?>

Available on NavigatorState, provided by the AppRouteNavigation extension

Replaces the current route with a new one.
pushRoute<TArgs, TResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, TArgs args) → Future<TResult?>

Available on NavigatorState, provided by the AppRouteNavigation extension

Pushes a new route onto the stack.
pushRouteAndRemoveUntil<TArgs, TResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, RoutePredicate predicate, {TArgs? arguments}) → Future<TResult?>

Available on NavigatorState, provided by the AppRouteNavigation extension

Pushes a new route and removes routes until predicate returns true.
restorablePopAndPushRoute<TArgs, TResult, TPopResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, {TPopResult? result, TArgs? arguments}) → String

Available on NavigatorState, provided by the AppRouteNavigation extension

Restorable version of popAndPushRoute.
restorablePushReplacementRoute<TArgs, TResult, TPopResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, {TPopResult? result, TArgs? arguments}) → String

Available on NavigatorState, provided by the AppRouteNavigation extension

Restorable version of pushReplacementRoute.
restorablePushRoute<TArgs, TResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, {TArgs? arguments}) → String

Available on NavigatorState, provided by the AppRouteNavigation extension

Restorable version of pushRoute.
restorablePushRouteAndRemoveUntil<TArgs, TResult, TRoute extends SafeRoute<TArgs, TResult>>(TRoute route, RoutePredicate predicate, {TArgs? arguments}) → String

Available on NavigatorState, provided by the AppRouteNavigation extension

Restorable version of pushRouteAndRemoveUntil.