GoRoute class Get started Configuration Redirection Transition animations Named routes

A route that is displayed visually above the matching parent route using the Navigator.

The widget returned by builder is wrapped in Page and provided to the root Navigator, the nearest ShellRoute ancestor's Navigator, or the Navigator with a matching parentNavigatorKey.

The Page depends on the application type: MaterialPage for MaterialApp, CupertinoPage for CupertinoApp, or NoTransitionPage for WidgetsApp.

Inheritance

Constructors

GoRoute({required String path, String? name, GoRouterWidgetBuilder? builder, GoRouterPageBuilder? pageBuilder, GlobalKey<NavigatorState>? parentNavigatorKey, GoRouterRedirect? redirect, ExitCallback? onExit, List<RouteBase> routes = const <RouteBase>[]})
Constructs a GoRoute.

Properties

builder → GoRouterWidgetBuilder?
A custom builder for this route.
final
hashCode → int
The hash code for this object.
no setterinherited
name → String?
Optional name of the route.
final
onExit → ExitCallback?
Called when this route is removed from GoRouter's route history.
final
pageBuilder → GoRouterPageBuilder?
A page builder for this route.
final
parentNavigatorKey → GlobalKey<NavigatorState>?
An optional key specifying which Navigator to display this route's screen onto.
finalinherited
path → String
The path of this go route.
final
pathParameters → List<String>
The path parameters in this route.
final
redirect → GoRouterRedirect?
An optional redirect function for this route.
finalinherited
redirectOnly → bool
Whether this GoRoute only redirects to another route.
no setter
routes → List<RouteBase>
The list of child routes associated with this route.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
override
extractPathParams(RegExpMatch match) → Map<String, String>
Extract the path parameters from a match.
matchPatternAsPrefix(String loc) → RegExpMatch?
Match this route against a location.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringShort() → String
A brief description of this object, usually just the runtimeType and the hashCode.
inherited

Operators

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