router_flutter library
Flutter navigation and page bindings for Odroe Router.
Classes
-
AppRoute<
P, S, D> - A typed route definition shared by manual and file routing.
- AppRouter
- Flutter's RouterConfig implementation backed by typed routes.
-
DecodedSearch<
S> - The result of decoding one route's search state.
- Destination
- An immutable navigation target.
- NoData
- The absence of route loader data.
- NoParams
- The absence of path parameters.
- NoSearch
- The absence of typed search state.
-
PageLoadContext<
P, S> - Typed input passed to a Flutter page loader.
-
PageRoute<
P, S, D> - A typed route with Flutter page behavior.
- PathInput
- Read-only access to raw path parameters.
- PathOutput
- Collects encoded path parameters.
-
PathParams<
P> - A bidirectional typed path-parameter contract.
- PathTemplate
- The reversible subset of Roux path syntax used by typed destinations.
- RouteBranch
- The matched root-to-leaf route branch.
-
RouteCapability<
T extends Object> - A typed key used by optional packages to extend a route definition.
-
RouteContext<
P, S> - Typed state shared by route lifecycle widgets.
- RouteLoadResult
- The outcome of one route loader.
-
RouteMatch<
P, S, D> - One typed route match.
- RouteMatcher
- Matches locations against an immutable route tree.
- RouteMatches
- The ordered matches for one location.
- RouteMetadata
- Descriptive route information shared by every runtime.
- Navigation operations available to route widgets.
- RouteNode
- A node stored in a route tree.
-
RoutePageContext<
P, S, D> - Typed state passed to a ready route page.
- RoutePageSettings
- Framework-owned settings for an advanced custom Page.
-
RoutePageState<
P, S, D> - Typed ready state used while constructing a custom Flutter Page.
-
RouteRef<
P, S, D> - One strongly typed, locally bound route reference.
- RouteRefPath
- An ordered branch of strongly typed route references.
- RouterInitialState
- Server-rendered loader data consumed by the first Flutter navigation.
- RouterModule
- Installs Flutter routing into an application context.
-
RouteState<
P, S> - Typed route state that does not depend on a Flutter build context.
-
RouteValues<
P, S> - Typed params and search belonging to one active route.
- SearchInput
- Read-only access to a URI query multimap.
- SearchOutput
- Collects encoded query values in canonical field order.
-
SearchParams<
S> - A bidirectional typed search-state contract.
-
ShellRoute<
P, S, D> - A typed route carrying a nested Flutter navigator.
-
TypedRoute<
P, S, D> - A route whose local params, search, and data types are known.
Enums
- InvalidSearchBehavior
- The behavior used when a URL contains invalid search values.
Extensions
-
AppRoutePage
on AppRoute<
P, S, D> - Attaches Flutter page behavior to a route definition.
-
AppRouteShell
on AppRoute<
P, S, D> - Attaches a nested Flutter navigator to a route definition.
-
ParameterizedRouteReference
on TypedRoute<
P, S, D> - Binds params and search to a typed route.
-
StaticRouteReference
on TypedRoute<
NoParams, S, D> - Binds search to a typed route without path parameters.
Properties
-
routerInitialStateKey
→ ContextKey<
RouterInitialState> -
Optional server-rendered state consumed by RouterModule.
final
-
routerKey
→ ContextKey<
AppRouter> -
The application context key used to read the configured AppRouter.
final
Typedefs
-
PageLoader<
P, S, D> = FutureOr< D> Function(PageLoadContext<P, S> context) - Loads data for a Flutter page or shell.
-
RouteErrorBuilder<
P, S> = Widget Function(RouteContext< P, S> context, Object error) - Builds a route loader failure.
-
RouteNotFoundBuilder<
P, S> = Widget Function(RouteContext< P, S> context) - Builds a matched route whose resource does not exist.
-
RoutePageBuilder<
P, S, D> = Page< Object?> Function(RoutePageState<P, S, D> state, RoutePageSettings settings) - Builds an advanced Flutter page for a ready route.
-
RoutePendingBuilder<
P, S> = Widget Function(RouteContext< P, S> context) - Builds a route while its loader is pending.
- RouterErrorBuilder = Widget Function(BuildContext context, Object error, StackTrace stackTrace)
- Builds a router-level error page.
-
RouteShellBuilder<
P, S, D> = Widget Function(RoutePageContext< P, S, D> context, ) - Builds a route shell around its active descendant navigator.
-
RouteWidgetBuilder<
P, S, D> = Widget Function(RoutePageContext< P, S, D> context) - Builds a ready route widget.
Exceptions / Errors
- ParameterFormatException
- An error produced while decoding path or search values.
- PathSyntaxException
- Invalid syntax in a typed route path.
- RouteNotFoundException
- Signals that a matched resource does not exist.
- SearchParameterFormatException
- A strict search-parameter decoding failure.