route library
Typed Flutter Navigator 2.0 routing annotations and runtime for Dust.
Classes
- AppRoute
- Marks a widget class as a typed route.
- AppRouter
- Marks the single router entrypoint for a Flutter application.
-
AsyncRouteGuard<
T extends Object> - Asynchronous route-specific guard contract.
- BottomToTopPageTransitionsBuilder
- Bottom-to-top page transition for fullscreen dialog routes.
- GeneratedRoute
- Generated route tree metadata.
-
GeneratedRouteInformationParser<
T extends Object> - Navigator 2.0 route information parser for generated routes.
-
GeneratedRouterDelegate<
T extends Object> - Navigator 2.0 delegate used by generated routers.
-
RouteGuard<
T extends Object> - Synchronous route-specific guard contract.
-
RouteGuardChain<
T extends Object> - Runs route guards in generated declaration order.
-
RouterBase<
T extends Object> - Base class for user-owned generated routers.
-
RouterController<
T extends Object> - Imperative navigation controller exposed through generated extensions.
-
RouterRuntimeConfig<
T extends Object> - Runtime configuration generated for one router.
- RouterScope
- Inherited scope used by generated BuildContext extensions.
Enums
- Internal navigation action mode.
Constants
- maxRedirects → const int
- Maximum redirect hops before the router reports a debug-cycle assertion.
Functions
-
generatedPage<
R> ({required LocalKey key, required String location, required String name, required Widget child, PopInvokedWithResultCallback< Object?> ? onPopInvoked, PageTransitionsBuilder? transition, bool fullscreenDialog = false, bool maintainState = true}) → Page<R> - Builds a generated Flutter page for one typed route.
Typedefs
-
RouteGuardResolver<
T extends Object> = List< Object> Function(T route) - Resolves route-level guards for one typed route object.
-
RouteLocation<
T extends Object> = String Function(T route) - Converts a typed route object back into a URL location.
-
RoutePageBuilder<
T extends Object> = Page Function(T route, LocalKey key, PopInvokedWithResultCallback< Object?> onPopInvoked) - Builds a Flutter page for one typed route object and stack entry key.
-
RouteParser<
T extends Object> = T Function(Uri uri) - Converts an incoming browser or platform URI into a typed route object.
-
RouteRequiresAuth<
T extends Object> = bool Function(T route) - Returns whether a route participates in auth checks.
-
RouteStack<
T extends Object> = List< T> - Mutable route stack maintained by the generated router delegate.
-
RouteStackRestorer<
T extends Object> = RouteStack< T> Function(T route) - Restores the Navigator page stack for a browser/deep-link route.