RouteConfiguration class
The route configuration for GoRouter configured by the app.
Constructors
-
RouteConfiguration({required List<
RouteBase> routes, required int redirectLimit, required GoRouterRedirect topRedirect, }) - Constructs a RouteConfiguration.
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
The global key for top level navigator.
final
- redirectLimit → int
-
The limit for the number of consecutive redirects.
final
-
routes
→ List<
RouteBase> -
The list of top level routes used by GoRouterDelegate.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- topRedirect → GoRouterRedirect
-
Top level page redirect.
final
Methods
-
buildTopLevelGoRouterState(
RouteMatchList matchList) → GoRouterState -
Builds a GoRouterState suitable for top level callback such as
GoRouter.redirect
orGoRouter.onException
. -
debugKnownRoutes(
) → String - Returns the full path of routes.
-
findMatch(
String location, {Object? extra}) → RouteMatchList - Finds the routes that matched the given URL.
-
locationForRoute(
RouteBase route) → String? - Get the location for the provided route.
-
namedLocation(
String name, {Map< String, String> pathParameters = const <String, String>{}, Map<String, dynamic> queryParameters = const <String, dynamic>{}}) → String - Looks up the url location by a GoRoute's name.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
redirect(
BuildContext context, FutureOr< RouteMatchList> prevMatchListFuture, {required List<RouteMatchList> redirectHistory}) → FutureOr<RouteMatchList> - Processes redirects by returning a new RouteMatchList representing the new location.
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited