FlowRoute class final

A typed route instance — no subclass needed.

Define route constants or factory functions in your app, then navigate:

context.flow(Routes.home);
context.flow(Routes.about, push: true);
context.pop();
Available extensions

Constructors

FlowRoute({required String name, required String pathTemplate, Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? fragment, Object? extra})
const

Properties

extra Object?
Optional typed payload attached at navigation time.
final
fragment String?
Optional URI fragment.
final
hashCode int
The hash code for this object.
no setteroverride
location String
Canonical URL location — never construct URLs manually.
no setter
name String
Stable route name used for named navigation and restoration.
final
pathParameters Map<String, String>
Path parameters for this route instance.
final
pathTemplate String
Path template, e.g. /users/:id.
final
queryParameters Map<String, String>
Query parameters for this route instance.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

copyWith({String? name, String? pathTemplate, Map<String, String>? pathParameters, Map<String, String>? queryParameters, String? fragment, Object? extra}) FlowRoute
extraAs<T>() → T?

Available on FlowRoute, provided by the FlowRouteAccess extension

Typed extra payload.
intPathParam(String key) int

Available on FlowRoute, provided by the FlowRouteAccess extension

Path parameter parsed as int.
isName(String name) bool
Whether this route matches name.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
optionalPathParam(String key) String?

Available on FlowRoute, provided by the FlowRouteAccess extension

Optional path parameter.
pathParam(String key) String

Available on FlowRoute, provided by the FlowRouteAccess extension

Required path parameter.
queryParam(String key) String?

Available on FlowRoute, provided by the FlowRouteAccess extension

Query parameter, if present.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
override