PageRoute<P, S, D> class final

A typed route with Flutter page behavior.

Implemented types
Available extensions

Properties

build → RouteWidgetBuilder<P, S, D>?
The default widget builder.
final
children → List<RouteNode>
Child routes.
no setteroverride
definition → AppRoute<P, S, D>
The client-safe route definition supplying this route's types.
final
error → RouteErrorBuilder<P, S>?
The error-state builder.
final
hashCode → int
The hash code for this object.
no setterinherited
hasPathCodec → bool
Whether dynamic path values have a typed codec.
no setteroverride
identity → Object
Stable identity shared by compiled route variants.
no setteroverride
load → PageLoader<P, S, D>?
Optional client-side loader.
final
metadata → RouteMetadata
Metadata shared by optional route capabilities.
no setteroverride
notFound → RouteNotFoundBuilder<P, S>?
The matched not-found builder.
final
page → RoutePageBuilder<P, S, D>?
The advanced page builder.
final
path → String?
The route's relative or absolute path declaration.
no setteroverride
pending → RouteNotFoundBuilder<P, S>?
The pending-state builder.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
template → PathTemplate
The parsed path template.
no setteroverride
terminal → bool
Whether this route can be the final match for a location.
no setteroverride

Methods

buildPage({required BuildContext context, required AppContext app, required RouteNavigator router, required RouteMatches matches, required RouteLoadResult? loadResult, required Object? pageScope, required PopInvokedWithResultCallback<Object?> onPopInvoked}) → Page<Object?>
Builds this route's Flutter page for one navigation snapshot.
capability<T extends Object>(RouteCapability<T> key) → T?
Reads an optional capability attached by another package entrypoint.
override
compiled({required String path, PathParams<P>? params, SearchParams<S>? search, required bool terminal, Iterable<RouteNode> children = const <RouteNode>[]}) → PageRoute<P, S, D>
Binds generated file-route configuration to this page route.
decodePath(Map<String, List<String>> values) → Object?
Decodes this route's path parameters.
override
decodeQuery(Map<String, List<String>> values) → DecodedSearch<Object?>
Decodes this route's search state.
override
encodePath(Object? params) → List<String>
Encodes this route's local path through the generated boundary.
override
encodeQuery(Object? search) → Map<String, List<String>>
Encodes this route's local search state.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
ref({required P params, S? search}) → RouteRef<P, S, D>

Available on TypedRoute<P, S, D>, provided by the ParameterizedRouteReference extension

Creates a local route reference.
ref({S? search}) → RouteRef<NoParams, S, D>

Available on TypedRoute<NoParams, S, D>, provided by the StaticRouteReference extension

Creates a local route reference.
runLoader({required AppContext app, required RouteNavigator router, required RouteMatches matches}) → FutureOr<Object?>
Runs this route's loader for the active branch.
to({required P params, S? search}) → Destination

Available on TypedRoute<P, S, D>, provided by the ParameterizedRouteReference extension

Builds a destination containing only this route.
to({S? search}) → Destination

Available on TypedRoute<NoParams, S, D>, provided by the StaticRouteReference extension

Builds a destination containing only this route.
toString() → String
A string representation of this object.
inherited
withChildren(Iterable<RouteNode> children) → PageRoute<P, S, D>
Returns a copy with children attached to the route definition.

Operators

operator ==(Object other) → bool
The equality operator.
inherited