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.
GeneratedNoTransitionBuilder
Page transition builder used by generated no-transition 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.
GeneratedRouteUriExtras
URI query and fragment values preserved from an incoming route.
RouteDebugInfo
Human-readable route facts used by diagnostics.
RouteGuard<T extends Object>
Synchronous route-specific guard contract.
RouteGuardBase<T extends Object>
Common supertype for every route guard accepted by generated routers.
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.
generatedRouteListEquals<T>(List<T> left, List<T> right) → bool
Compares generated route list defaults without relying on identity.
generatedRouteParseBool(String? value) → bool?
Parses the URL bool spelling supported by generated route parameters.
generatedRouteParseEnum<T extends Enum>(Iterable<T> values, String? value) → T?
Parses a URL enum value by Dart enum name.
generatedRouteParseIntList(List<String>? values) → List<int>?
Parses repeated URL query values as integers.
generatedRoutePath(List<String> segments, {Map<String, dynamic>? queryParameters, GeneratedRouteUriExtras? uriExtras}) → String
Builds a generated route location from path segments, query, and extras.
generatedRouteShellsMatch(List<GeneratedRoute> routes, Map<Type, Type?> appliedShellsByPage) → bool
Checks that generated page wrapping matches generated route metadata.
generatedRouteUriExtrasOf(Object route) → GeneratedRouteUriExtras?
Returns preserved URI extras for a generated route instance.
withGeneratedRouteUriExtras<T extends Object>(T route, Uri uri, Set<String> knownQueryParameters) → T
Stores unknown query parameters and fragments on a parsed generated route.

Typedefs

RouteBranch<T extends Object> = String? Function(T route)
Returns the stateful navigation branch for a route, if any.
RouteDebugInfoResolver<T extends Object> = RouteDebugInfo Function(T route)
Returns debug metadata for a typed route.
RouteGuardResolver<T extends Object> = List<RouteGuardBase<T>> 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.