routing library

Classes

GoRoute Get started Configuration Redirection Transition animations Named routes
A route that is displayed visually above the matching parent route using the Navigator.
GoRouter Get started Upgrading Configuration Navigation Redirection Web Deep linking Named routes Error handling State restoration
The route configuration for the app.
GoRouterState
The route state during routing.
RouteBase
The base class for GoRoute and ShellRoute.
ShellRoute Configuration
A route that displays a UI shell around the matching child route.
StatefulShellBranch
Representation of a separate branch in a stateful navigation tree, used to configure StatefulShellRoute.
StatefulShellRoute Configuration
A route that displays a UI shell with separate Navigators for its sub-routes.
VoRouteObserver
Logs navigation events via VoLogger. Registered by voRouterProvider.
VoRouterNotifier
Triggers GoRouter to re-run VoRoutingConfig.redirect.
VoRouterProvider
App-wide GoRouter built from VoConfig.routing and voAppRoutesProvider.
VoRoutingConfig
Router settings supplied through VoConfig.routing.

Extensions

GoRouterHelper on BuildContext
Dart extension to add navigation function to a BuildContext object, e.g. context.go('/');

Properties

voNavigatorKey → GlobalKey<NavigatorState>
Root navigator key used by voRouterProvider.
final
voRouterProvider → VoRouterProvider
App-wide GoRouter built from VoConfig.routing and voAppRoutesProvider.
final

Functions

voRouter(Ref ref) → GoRouter
App-wide GoRouter built from VoConfig.routing and voAppRoutesProvider.

Typedefs

VoRouterErrorBuilder = Widget Function(BuildContext context, GoRouterState state)
Builds the page shown when no route matches the location.
VoRouterInit = void Function(Ref ref, VoRouterNotifier notifier)
Called once when the router is created. Use ref to listen to providers and call VoRouterNotifier.notify so VoRoutingConfig.redirect re-runs.
VoRouterRedirect = FutureOr<String?> Function(Ref ref, BuildContext context, GoRouterState state)
Redirect callback with access to Riverpod state (auth, onboarding, …).