AutoRouterX extension

An extension that provides common routing helpers on BuildContext

on

Properties

routeData RouteData

Available on BuildContext, provided by the AutoRouterX extension

Helper to read the scoped RouteData of a route
no setter
router StackRouter

Available on BuildContext, provided by the AutoRouterX extension

Helper to read the scoped router
no setter
tabsRouter TabsRouter

Available on BuildContext, provided by the AutoRouterX extension

Helper to read the scoped TabsRouter
no setter
topRoute RouteData

Available on BuildContext, provided by the AutoRouterX extension

Returns the top most rendered route
no setter
topRouteMatch RouteMatch

Available on BuildContext, provided by the AutoRouterX extension

Returns the top most match rendered or pending
no setter
watchRouter StackRouter

Available on BuildContext, provided by the AutoRouterX extension

Helper to watch the scoped router
no setter
watchTabsRouter TabsRouter

Available on BuildContext, provided by the AutoRouterX extension

Helper to watch the scoped TabsRouter
no setter

Methods

back() → void

Available on BuildContext, provided by the AutoRouterX extension

see RoutingController.back
innerRouterOf<T extends RoutingController>(String routeKey) → T?

Available on BuildContext, provided by the AutoRouterX extension

see RoutingController.innerRouterOf
maybePop<T extends Object?>([T? result]) Future<bool>

Available on BuildContext, provided by the AutoRouterX extension

see StackRouter.maybePop

Available on BuildContext, provided by the AutoRouterX extension

see RoutingController.navigatePath

Available on BuildContext, provided by the AutoRouterX extension

see RoutingController.navigate

Available on BuildContext, provided by the AutoRouterX extension

see RoutingController.navigatePath
pop<T extends Object?>([T? result]) → void

Available on BuildContext, provided by the AutoRouterX extension

see StackRouter.pop
pushRoute<T extends Object?>(PageRouteInfo<Object?> route, {OnNavigationFailure? onFailure}) Future<T?>

Available on BuildContext, provided by the AutoRouterX extension

see StackRouter.push
replaceRoute<T extends Object?>(PageRouteInfo<Object?> route, {OnNavigationFailure? onFailure}) Future<T?>

Available on BuildContext, provided by the AutoRouterX extension

see StackRouter.replace