GoRouter

https://pub.dev/documentation/go_router/latest
Admin
GoRouter is a declarative routing package for Flutter that enables URL-based navigation with support...
Tokens:124,427
Snippets:1,113
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### hashCode Implementation Example

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouterState/hashCode.html

Provides an example implementation of the hashCode getter using Object.hash.

```APIDOC
## Implementation

### Description
This section shows a typical implementation of the `hashCode` getter, often used when overriding the equality operator (`==`). It utilizes `Object.hash` to combine the hash codes of relevant object properties.

### Method
`@override int get hashCode`

### Endpoint
Not applicable (instance method)

### Parameters
None

### Request Body
None

### Request Example
```dart
@override
int get hashCode => Object.hash(
  uri,
  matchedLocation,
  name,
  path,
  fullPath,
  pathParameters,
  extra,
  error,
  pageKey,
);
```

### Response
#### Success Response (200)
- **hashCode** (int) - The computed hash code based on the object's state.

#### Response Example
```dart
// Example of a computed hash code value
1987654321
```
```

--------------------------------

### hashCode Implementation Example

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatch/hashCode.html

Provides an example of how to implement the `hashCode` property in a Dart class, ensuring consistency with the equality operator.

```APIDOC
## Implementation

### Method
`int get hashCode`

### Endpoint
N/A (Instance property)

### Description
This section shows a typical implementation of the `hashCode` getter, often used in conjunction with other properties that define object equality.

### Request Example
```dart
@override
int get hashCode => Object.hash(route, matchedLocation, pageKey);
```

### Response
#### Success Response (200)
- **hashCode** (int) - The computed hash code for the object.
```

--------------------------------

### Example Usage of ShellRoute

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRoute-class.html

Demonstrates how to configure a GoRouter with ShellRoutes and nested GoRoutes, including displaying a child route on the root Navigator.

```APIDOC
## Example Usage of ShellRoute

```dart
final GlobalKey<NavigatorState> _rootNavigatorKey = GlobalKey<NavigatorState>();

final GoRouter _router = GoRouter(
  navigatorKey: _rootNavigatorKey,
  initialLocation: '/a',
  routes: [
    ShellRoute(
      navigatorKey: _shellNavigatorKey,
      builder: (context, state, child) {
        return ScaffoldWithNavBar(child: child);
      },
      routes: [
        // This screen is displayed on the ShellRoute's Navigator.
        GoRoute(
          path: '/a',
          builder: (context, state) {
            return const ScreenA();
          },
          routes: <RouteBase>[
            // This screen is displayed on the ShellRoute's Navigator.
            GoRoute(
              path: 'details',
              builder: (BuildContext context, GoRouterState state) {
                return const DetailsScreen(label: 'A');
              },
            ),
          ],
        ),
        // Displayed ShellRoute's Navigator.
        GoRoute(
          path: '/b',
          builder: (BuildContext context, GoRouterState state) {
            return const ScreenB();
          },
          routes: <RouteBase>[
            // Displayed on the root Navigator by specifying the
            // [parentNavigatorKey].
            GoRoute(
              path: 'details',
              parentNavigatorKey: _rootNavigatorKey,
              builder: (BuildContext context, GoRouterState state) {
                return const DetailsScreen(label: 'B');
              },
            ),
          ],
        ),
      ],
    ),
  ],
);
```

### Description
This example shows a `GoRouter` configuration with a `ShellRoute`. The `ShellRoute` uses a `ScaffoldWithNavBar` as its shell and contains two child routes, `/a` and `/b`. The `/a/details` route is displayed on the `ShellRoute`'s navigator, while the `/b/details` route is configured to display on the root navigator using `parentNavigatorKey`.
```

--------------------------------

### Example fullPath pattern

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchList/fullPath.html

A string representation of a route path pattern containing dynamic parameters.

```text
'/family/:fid/person/:pid'
```

--------------------------------

### Implement debugFillProperties with DiagnosticsProperty

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBase/debugFillProperties.html

This example demonstrates best practices for implementing debugFillProperties, showcasing the use of various DiagnosticsProperty subclasses and parameters. It includes examples for String, Double, Int, Percent, ObjectFlag, Flag, Enum, and lazy properties.

```dart
class ExampleObject extends ExampleSuperclass {

  // ...various members and properties...

  @override
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    // Always add properties from the base class first.
    super.debugFillProperties(properties);

    // Omit the property name 'message' when displaying this String property
    // as it would just add visual noise.
    properties.add(StringProperty('message', message, showName: false));

    properties.add(DoubleProperty('stepWidth', stepWidth));

    // A scale of 1.0 does nothing so should be hidden.
    properties.add(DoubleProperty('scale', scale, defaultValue: 1.0));

    // If the hitTestExtent matches the paintExtent, it is just set to its
    // default value so is not relevant.
    properties.add(DoubleProperty('hitTestExtent', hitTestExtent, defaultValue: paintExtent));

    // maxWidth of double.infinity indicates the width is unconstrained and
    // so maxWidth has no impact.
    properties.add(DoubleProperty('maxWidth', maxWidth, defaultValue: double.infinity));

    // Progress is a value between 0 and 1 or null. Showing it as a
    // percentage makes the meaning clear enough that the name can be
    // hidden.
    properties.add(PercentProperty(
      'progress',
      progress,
      showName: false,
      ifNull: '<indeterminate>',
    ));

    // Most text fields have maxLines set to 1.
    properties.add(IntProperty('maxLines', maxLines, defaultValue: 1));

    // Specify the unit as otherwise it would be unclear that time is in
    // milliseconds.
    properties.add(IntProperty('duration', duration.inMilliseconds, unit: 'ms'));

    // Tooltip is used instead of unit for this case as a unit should be a
    // terse description appropriate to display directly after a number
    // without a space.
    properties.add(DoubleProperty(
      'device pixel ratio',
      devicePixelRatio,
      tooltip: 'physical pixels per logical pixel',
    ));

    // Displaying the depth value would be distracting. Instead only display
    // if the depth value is missing.
    properties.add(ObjectFlagProperty<int>('depth', depth, ifNull: 'no depth'));

    // bool flag that is only shown when the value is true.
    properties.add(FlagProperty('using primary controller', value: primary));

    properties.add(FlagProperty(
      'isCurrent',
      value: isCurrent,
      ifTrue: 'active',
      ifFalse: 'inactive',
    ));

    properties.add(DiagnosticsProperty<bool>('keepAlive', keepAlive));

    // FlagProperty could have also been used in this case.
    // This option results in the text "obscureText: true" instead
    // of "obscureText" which is a bit more verbose but a bit clearer.
    properties.add(DiagnosticsProperty<bool>('obscureText', obscureText, defaultValue: false));

    properties.add(EnumProperty<TextAlign>('textAlign', textAlign, defaultValue: null));
    properties.add(EnumProperty<ImageRepeat>('repeat', repeat, defaultValue: ImageRepeat.noRepeat));

    // Warn users when the widget is missing but do not show the value.
    properties.add(ObjectFlagProperty<Widget>('widget', widget, ifNull: 'no widget'));

    properties.add(IterableProperty<BoxShadow>(
      'boxShadow',
      boxShadow,
      defaultValue: null,
      style: style,
    ));

    // Getting the value of size throws an exception unless hasSize is true.
    properties.add(DiagnosticsProperty<Size>.lazy(
      'size',
      () => size,
      description: '${ hasSize ? size : "MISSING" }',
    ));

    // If the `toString` method for the property value does not provide a
    // good terse description, write a DiagnosticsProperty subclass as in
    // the case of TransformProperty which displays a nice debugging view

```

--------------------------------

### Basic ShellRoute Builder Example

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRoute-class.html

A simple example of a ShellRoute's builder function. The `child` parameter represents the widget built by the matching sub-route, which is typically placed within the shell's layout.

```dart
ShellRoute(
  builder: (BuildContext context, GoRouterState state, Widget child) {
    return Scaffold(
      appBar: AppBar(
        title: Text('App Shell')
      ),
      body: Center(
        child: child,
      ),
    );
  },
  routes: [
    GoRoute(
      path: 'a'
      builder: (BuildContext context, GoRouterState state) {
        return Text('Child Route "/a"');
      }
    ),
  ],
),
```

--------------------------------

### Configure DiagnosticsProperty output

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBase/debugFillProperties.html

Examples demonstrating how to use showSeparator and showName to refine the string representation of diagnostic properties.

```dart
DiagnosticsProperty<Object>('child(3, 4)', null, ifNull: 'is null', showSeparator: false).toString()
```

```dart
DiagnosticsProperty<IconData>('icon', icon, ifNull: '<empty>', showName: false).toString()
```

--------------------------------

### ShellRoute with Nested Routes and Parent Navigator Key

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRoute-class.html

This example demonstrates configuring a ShellRoute with nested GoRoutes. It shows how to use a `parentNavigatorKey` to direct a specific child route to display on the root Navigator instead of the ShellRoute's own Navigator.

```dart
final GlobalKey<NavigatorState> _rootNavigatorKey =
    GlobalKey<NavigatorState>();

  final GoRouter _router = GoRouter(
    navigatorKey: _rootNavigatorKey,
    initialLocation: '/a',
    routes: [
      ShellRoute(
        navigatorKey: _shellNavigatorKey,
        builder: (context, state, child) {
          return ScaffoldWithNavBar(child: child);
        },
        routes: [
          // This screen is displayed on the ShellRoute's Navigator.
          GoRoute(
            path: '/a',
            builder: (context, state) {
              return const ScreenA();
            },
            routes: <RouteBase>[
              // This screen is displayed on the ShellRoute's Navigator.
              GoRoute(
                path: 'details',
                builder: (BuildContext context, GoRouterState state) {
                  return const DetailsScreen(label: 'A');
                },
              ),
            ],
          ),
          // Displayed ShellRoute's Navigator.
          GoRoute(
            path: '/b',
            builder: (BuildContext context, GoRouterState state) {
              return const ScreenB();
            },
            routes: <RouteBase>[
              // Displayed on the root Navigator by specifying the
              // [parentNavigatorKey].
              GoRoute(
                path: 'details',
                parentNavigatorKey: _rootNavigatorKey,
                builder: (BuildContext context, GoRouterState state) {
                  return const DetailsScreen(label: 'B');
                },
              ),
            ],
          ),
        ],
      ),
    ],
  );
```

--------------------------------

### Create GoException with Message

Source: https://pub.dev/documentation/go_router/latest/go_router/GoException/GoException.html

Use this constructor to create a GoException instance with a descriptive message. No additional setup is required.

```dart
GoException(this.message);
```

--------------------------------

### Set initial location in GoRouter

Source: https://pub.dev/documentation/go_router/latest/topics/Configuration-topic.html

Define the starting route for the application when no deep link is provided.

```dart
GoRouter(
  initialLocation: '/details',
  /* ... */
);
```

--------------------------------

### Configure GoRouter with HomeScreen Route

Source: https://pub.dev/documentation/go_router/latest/topics/Upgrading-topic.html

Use this configuration to start upgrading an app that uses Navigator. It sets up a single GoRoute for the home screen.

```dart
import 'package:go_router/go_router.dart';

final _router = GoRouter(
  routes: [
    GoRoute(
      path: '/',
      builder: (context, state) => const HomeScreen(),
    ),
  ],
);

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp.router(
      routerConfig: _router,
    );
  }
}

```

--------------------------------

### void go(BuildContext context)

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouteData/go.html

Navigates to the specified route using the provided BuildContext.

```APIDOC
## void go(BuildContext context)

### Description
Navigate to the route.

### Parameters
#### Path Parameters
- **context** (BuildContext) - Required - The BuildContext used to perform the navigation.

### Request Example
```dart
context.go('/home');
```
```

--------------------------------

### Get Relative Location of a Route

Source: https://pub.dev/documentation/go_router/latest/go_router/RelativeGoRouteData/relativeLocation.html

This code defines how to get the relative location of a route. It is part of the internal implementation and should be generated.

```dart
String get relativeLocation => throw _GoRouteDataBase.shouldBeGeneratedError;
```

--------------------------------

### void goBranch(int index, {bool initialLocation = false})

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShellState-class.html

Navigates to the last location of the StatefulShellBranch at the provided index.

```APIDOC
## void goBranch(int index, {bool initialLocation = false})

### Description
Navigates to the last location of the StatefulShellBranch at the provided index in the associated StatefulShellBranch.

### Parameters
#### Path Parameters
- **index** (int) - Required - The index of the branch to navigate to.

#### Query Parameters
- **initialLocation** (bool) - Optional - Whether to navigate to the initial location of the branch.
```

--------------------------------

### Invalid StatefulWidget build method example

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShellState/build.html

An example demonstrating why placing the build method on StatefulWidget instead of State can lead to stale closure captures.

```dart
// (this is not valid Flutter code)
class MyButton extends StatefulWidgetX {
  MyButton({super.key, required this.color});

  final Color color;

  @override
  Widget build(BuildContext context, State state) {
    return SpecialWidget(
      handler: () { print('color: $color'); },
    );
  }
}
```

--------------------------------

### Allow Class Overview

Source: https://pub.dev/documentation/go_router/latest/go_router/Allow-class.html

Provides details about the Allow class, its constructors, properties, and methods.

```APIDOC
## Allow Class

Allows the navigation to proceed. The then callback runs **after** the navigation is committed. Errors thrown by this callback are reported via `FlutterError.reportError` and do **not** undo the already-committed navigation.

### Constructors

*   **Allow**({OnEnterThenCallback? then})
    Creates an Allow result with an optional `then` callback executed after navigation completes.

### Properties

*   **hashCode** → int
    The hash code for this object.
*   **isStop** → bool
    Whether this block represents a hard stop without a follow-up callback.
*   **runtimeType** → Type
    A representation of the runtime type of the object.
*   **then** → OnEnterThenCallback?
    Executed after the decision is committed. Errors are reported and do not revert navigation.

### Methods

*   **noSuchMethod**(Invocation invocation) → dynamic
    Invoked when a nonexistent method or property is accessed.
*   **toString**() → String
    A string representation of this object.

### Operators

*   **operator ==**(Object other) → bool
    The equality operator.
```

--------------------------------

### void go(String location, {Object? extra})

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouterHelper/go.html

Navigates to a specified location using the GoRouter instance.

```APIDOC
## void go(String location, {Object? extra})

### Description
Navigate to a location.

### Parameters
#### Path Parameters
- **location** (String) - Required - The path to navigate to.

#### Request Body
- **extra** (Object?) - Optional - Additional data to pass during navigation.

### Request Example
context.go('/profile', extra: {'userId': 123});

### Implementation
```dart
void go(String location, {Object? extra}) =>
    GoRouter.of(this).go(location, extra: extra);
```
```

--------------------------------

### go method

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouteInformationProvider/go.html

Navigates to a new location by replacing the current route matches.

```APIDOC
## void go(String location, {Object? extra})

### Description
Replaces the current route matches with the specified location.

### Parameters
#### Path Parameters
- **location** (String) - Required - The path to navigate to.

#### Request Body
- **extra** (Object?) - Optional - Additional data to pass to the route.

### Request Example
```dart
context.go('/details', extra: {'id': 1});
```
```

--------------------------------

### GET navigatorKey

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouterDelegate/navigatorKey.html

Retrieves the GlobalKey<NavigatorState> used by the RouterDelegate.

```APIDOC
## GET navigatorKey

### Description
Retrieves the GlobalKey<NavigatorState> for use by the Router architecture as part of the RouterDelegate.

### Method
GET

### Endpoint
navigatorKey

### Response
#### Success Response (200)
- **navigatorKey** (GlobalKey<NavigatorState>) - The key used to manage the Navigator state.
```

--------------------------------

### void goBranch(int index, {bool initialLocation = false})

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShell/goBranch.html

Navigates to the last location of the StatefulShellBranch at the provided index. If the branch is unvisited or initialLocation is true, it navigates to the branch's initial location.

```APIDOC
## void goBranch(int index, {bool initialLocation = false})

### Description
Navigates to the last location of the StatefulShellBranch at the provided index in the associated StatefulShellRoute. This method switches the currently active branch Navigator.

### Parameters
- **index** (int) - Required - The index of the branch to navigate to.
- **initialLocation** (bool) - Optional - If true, forces navigation to the branch's initial location regardless of previous history. Defaults to false.
```

--------------------------------

### GET routeInformationProvider

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouter/routeInformationProvider.html

Retrieves the GoRouteInformationProvider instance used by the GoRouter.

```APIDOC
## GET routeInformationProvider

### Description
The routeInformationProvider property is a late final getter that provides the route information used by the GoRouter instance.

### Method
GET

### Endpoint
routeInformationProvider

### Implementation
```dart
@override
late final GoRouteInformationProvider routeInformationProvider;
```
```

--------------------------------

### GET routes property

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchList/routes.html

Retrieves the list of routes for each of the current matches.

```APIDOC
## GET routes

### Description
Returns a list of RouteBase objects representing the routes for each of the current matches.

### Method
GET

### Endpoint
routes

### Response
- **List<RouteBase>** - A list containing the route definitions for the current navigation state.
```

--------------------------------

### GET subLocation Property

Source: https://pub.dev/documentation/go_router/latest/go_router/RelativeGoRouteData/subLocation.html

Retrieves the sub-location string for a given route.

```APIDOC
## GET subLocation

### Description
Returns the sub-location of the current route (e.g., 'person/p1').

### Implementation
```dart
String get subLocation => throw _GoRouteDataBase.shouldBeGeneratedError;
```
```

--------------------------------

### go(BuildContext context)

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouteData-class.html

Navigates to the route represented by this GoRouteData instance.

```APIDOC
## void go(BuildContext context)

### Description
Navigates to the route represented by this GoRouteData instance.

### Parameters
- **context** (BuildContext) - Required - The build context used for navigation.
```

--------------------------------

### goRelative Method

Source: https://pub.dev/documentation/go_router/latest/go_router/RelativeGoRouteData/goRelative.html

Navigates to the specified route using the provided BuildContext.

```APIDOC
## void goRelative(BuildContext context)

### Description
Navigates to the route.

### Parameters
#### Path Parameters
- **context** (BuildContext) - Required - The build context used for navigation.

### Implementation
```dart
void goRelative(BuildContext context) =>
    throw _GoRouteDataBase.shouldBeGeneratedError;
```
```

--------------------------------

### GET topOnEnter

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteConfiguration/topOnEnter.html

Retrieves the top-level onEnter callback from the current routing configuration.

```APIDOC
## GET topOnEnter

### Description
Retrieves the top-level page onEnter callback defined in the routing configuration.

### Method
GET

### Endpoint
topOnEnter

### Response
- **OnEnter?** - The top-level onEnter callback if defined, otherwise null.
```

--------------------------------

### void pushReplacement(BuildContext context)

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouteData/pushReplacement.html

Replaces the top-most page of the page stack with the route.

```APIDOC
## void pushReplacement(BuildContext context)

### Description
Replaces the top-most page of the page stack with the route.

### Parameters
#### Path Parameters
- **context** (BuildContext) - Required - The current build context.
```

--------------------------------

### GET routes property

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteConfiguration/routes.html

Retrieves the list of top-level routes used by the GoRouterDelegate.

```APIDOC
## GET routes

### Description
Returns the list of top-level routes currently configured for the GoRouterDelegate.

### Method
GET

### Endpoint
routes

### Response
- **routes** (List<RouteBase>) - The list of top-level routes used by GoRouterDelegate.
```

--------------------------------

### Method: buildPage

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulShellRoute/buildPage.html

Attempts to build the Page representing a shell route. Returns null if the route uses a Widget instead of a Page.

```APIDOC
## buildPage

### Description
Attempts to build the Page representing this shell route. Returns null if this shell route does not build a Page, but instead uses a Widget to represent itself.

### Parameters
- **context** (BuildContext) - Required - The build context for the route.
- **state** (GoRouterState) - Required - The current state of the GoRouter.
- **shellRouteContext** (ShellRouteContext) - Required - The context specific to the shell route.

### Returns
- **Page<dynamic>?** - The constructed Page object or null if not applicable.
```

--------------------------------

### GET restorationId

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShellState/restorationId.html

Retrieves the restoration ID used for the RestorationBucket to manage state restoration.

```APIDOC
## GET restorationId

### Description
The restorationId property is used to claim a child RestorationScope from the surrounding RestorationScope. It determines where the mixin stores restoration data for registered properties.

### Method
GET

### Endpoint
restorationId

### Response
- **restorationId** (String?) - The unique identifier for the RestorationBucket. Returns null if state restoration is disabled or no surrounding RestorationScope is available.

### Implementation
```dart
@override
String? get restorationId => route.restorationScopeId;
```
```

--------------------------------

### GET route property

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShell/route.html

Retrieves the StatefulShellRoute associated with the current shell route context.

```APIDOC
## GET route

### Description
Returns the associated StatefulShellRoute from the shellRouteContext.

### Method
GET

### Endpoint
route

### Response
- **StatefulShellRoute** (object) - The associated StatefulShellRoute instance.
```

--------------------------------

### RouteConfiguration Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteConfiguration/RouteConfiguration.html

Initializes a new RouteConfiguration instance with the provided routing configuration and navigator key.

```APIDOC
## RouteConfiguration Constructor

### Description
Constructs a RouteConfiguration instance. It initializes the routing configuration listener and sets up the navigator state.

### Parameters
- **_routingConfig** (ValueListenable<RoutingConfig>) - Required - The routing configuration to listen to.
- **navigatorKey** (GlobalKey<NavigatorState>) - Required - The key used to manage the navigator state.
- **extraCodec** (Codec<Object?, Object?>?) - Optional - A codec for extra objects.
- **router** (GoRouter?) - Optional - The associated GoRouter instance.
```

--------------------------------

### GET GoRouterState

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouter/state.html

Accesses the current state of the route last used in GoRouter.go or GoRouter.push.

```APIDOC
## GET GoRouterState

### Description
Retrieves the top GoRouterState, representing the state of the route that was last used in either GoRouter.go or GoRouter.push.

### Implementation
```dart
GoRouterState get state => routerDelegate.state;
```

### Usage Note
Accessing this property via GoRouter.of(context).state will not cause a rebuild if the state has changed. It is recommended to use GoRouterState.of(context) instead for reactive updates.
```

--------------------------------

### Initialize GoRouteInformationProvider

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouteInformationProvider/GoRouteInformationProvider.html

Constructor for creating a new GoRouteInformationProvider instance.

```dart
GoRouteInformationProvider({
  required String initialLocation,
  required Object? initialExtra,
  Listenable? refreshListenable,
  bool routerNeglect = false,
}) : _refreshListenable = refreshListenable,
     _value = RouteInformation(
       uri: Uri.parse(initialLocation),
       state: RouteInformationState<void>(
         extra: initialExtra,
         type: NavigatingType.go,
       ),
     ),
     _valueInEngine = _kEmptyRouteInformation,
     _routerNeglect = routerNeglect {
  _refreshListenable?.addListener(notifyListeners);
}
```

--------------------------------

### buildWidget Method

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRoute/buildWidget.html

Attempts to build the Widget representing a shell route. Returns null if the route uses a Page instead of a Widget.

```APIDOC
## buildWidget(BuildContext context, GoRouterState state, ShellRouteContext shellRouteContext)

### Description
Attempts to build the Widget representing this shell route. Returns null if this shell route does not build a Widget, but instead uses a Page to represent itself.

### Parameters
- **context** (BuildContext) - Required - The build context for the widget.
- **state** (GoRouterState) - Required - The current state of the GoRouter.
- **shellRouteContext** (ShellRouteContext) - Required - The context for the shell route, used to build the navigator.

### Implementation
```dart
@override
Widget? buildWidget(
  BuildContext context,
  GoRouterState state,
  ShellRouteContext shellRouteContext,
) {
  if (builder != null) {
    final Widget navigator = shellRouteContext._buildNavigatorForCurrentRoute(
      context,
      observers,
      notifyRootObserver,
      restorationScopeId,
    );
    return builder!(context, state, navigator);
  }
  return null;
}
```
```

--------------------------------

### StatefulShellRouteData Default Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulShellRouteData/StatefulShellRouteData.html

Use this constructor to create a new instance of StatefulShellRouteData. No specific setup is required.

```dart
const StatefulShellRouteData();
```

--------------------------------

### StatefulNavigationShellState Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShellState/StatefulNavigationShellState.html

Initializes a new instance of the StatefulNavigationShellState class.

```APIDOC
## StatefulNavigationShellState constructor

### Description
Initializes a new instance of the StatefulNavigationShellState class.

### Method
constructor

### Endpoint
N/A

### Parameters
This constructor does not accept any parameters.

### Request Example
N/A

### Response
N/A
```

--------------------------------

### Allow Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/Allow/Allow.html

Documentation for the Allow class constructor used to permit navigation with an optional callback.

```APIDOC
## Allow Constructor

### Description
Creates an Allow result with an optional `then` callback executed after navigation completes.

### Parameters
#### Optional Parameters
- **then** (OnEnterThenCallback) - Optional - A callback function executed after the navigation completes.
```

--------------------------------

### Implement go static method

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteInformationState/go.html

Factory constructor for creating a RouteInformationState with the go navigation type.

```dart
static RouteInformationState<void> go({Object? extra}) =>
    RouteInformationState<void>(extra: extra, type: NavigatingType.go);
```

--------------------------------

### GET isStop Property

Source: https://pub.dev/documentation/go_router/latest/go_router/OnEnterResult/isStop.html

Retrieves the boolean status of the isStop property to determine if a block acts as a hard stop.

```APIDOC
## GET isStop

### Description
Returns a boolean value indicating whether the current block represents a hard stop without a follow-up callback.

### Method
GET

### Endpoint
/isStop

### Response
#### Success Response (200)
- **isStop** (bool) - True if the block is a hard stop, false otherwise.

### Response Example
{
  "isStop": true
}
```

--------------------------------

### Initialize RouteMatchList

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchList/RouteMatchList.html

Constructs a new RouteMatchList instance with required route matches, URI, and path parameters.

```dart
RouteMatchList({
  required this.matches,
  required this.uri,
  this.extra,
  this.error,
  required this.pathParameters,
}) : fullPath = _generateFullPath(matches);
```

--------------------------------

### ShellRouteContext Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRouteContext/ShellRouteContext.html

Details the required parameters for constructing a ShellRouteContext instance.

```APIDOC
## ShellRouteContext Constructor

### Description
Constructs a ShellRouteContext instance used for managing nested navigation within a ShellRoute.

### Parameters
- **route** (ShellRouteBase) - Required - The shell route base configuration.
- **routerState** (GoRouterState) - Required - The current state of the GoRouter.
- **navigatorKey** (GlobalKey<NavigatorState>) - Required - The key associated with the shell navigator.
- **match** (ShellRouteMatch) - Required - The specific shell route match.
- **routeMatchList** (RouteMatchList) - Required - The list of current route matches.
- **navigatorBuilder** (NavigatorBuilder) - Required - The builder function for the navigator.
```

--------------------------------

### Override hashCode implementation

Source: https://pub.dev/documentation/go_router/latest/go_router/ImperativeRouteMatch/hashCode.html

Example of overriding the hashCode property to incorporate object state, ensuring consistency with the equality operator.

```dart
@override
int get hashCode => Object.hash(super.hashCode, completer, matches.hashCode);
```

--------------------------------

### Initialize GoRouter

Source: https://pub.dev/documentation/go_router/latest/topics/Configuration-topic.html

Create a GoRouter instance by providing a list of GoRoute objects to the routes parameter.

```dart
GoRouter(
  routes: [
    GoRoute(
      path: '/',
      builder: (context, state) => const Page1Screen(),
    ),
    GoRoute(
      path: '/page2',
      builder: (context, state) => const Page2Screen(),
    ),
  ],
);
```

--------------------------------

### Get StatefulNavigationShellState

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShell/of.html

Use this static method to access the nearest `StatefulNavigationShellState` in the widget tree. An assertion ensures that a `StatefulNavigationShellState` is present.

```dart
static StatefulNavigationShellState of(BuildContext context) {
  final StatefulNavigationShellState? shellState = context
      .findAncestorStateOfType<StatefulNavigationShellState>();
  assert(shellState != null);
  return shellState!;
}
```

--------------------------------

### Get topRedirect Property

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteConfiguration/topRedirect.html

Accesses the redirect configuration from the routing settings. This property is used for legacy top-level page redirects.

```dart
GoRouterRedirect get topRedirect => _routingConfig.value.redirect;
```

--------------------------------

### Go Method Navigation

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouter/go.html

The `go` method allows you to navigate to a specified URI location. You can also include optional extra data.

```APIDOC
## void go(String location, {Object? extra})

### Description
Navigates to a URI location with optional query parameters. For example: `/family/f2/person/p1?color=blue`.

### Method
`go`

### Parameters
#### Path Parameters
- **location** (String) - Required - The URI location to navigate to.
- **extra** (Object) - Optional - Additional data to pass with the navigation.

### Request Example
```dart
go('/users/123', extra: {'name': 'John Doe'});
```

### Response
This method does not return a value directly, but triggers a navigation event.
```

--------------------------------

### Get Debug Loaded Branches

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShell/debugLoadedBranches.html

Retrieves a list of loaded branches, which are branches that have navigation state associated with them. This property is annotated with `@visibleForTesting`.

```dart
@visibleForTesting
List<StatefulShellBranch> get debugLoadedBranches =>
    route._shellStateKey.currentState?._loadedBranches ??
    <StatefulShellBranch>[];
```

--------------------------------

### ShellRouteContext Class

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRouteContext-class.html

Documentation for the ShellRouteContext constructor and its properties.

```APIDOC
## ShellRouteContext Class

### Description
Context object used when building the shell and Navigator for a shell route.

### Constructor
ShellRouteContext({required ShellRouteBase route, required GoRouterState routerState, required GlobalKey<NavigatorState> navigatorKey, required ShellRouteMatch match, required RouteMatchList routeMatchList, required NavigatorBuilder navigatorBuilder})

### Properties
- **route** (ShellRouteBase) - The associated shell route.
- **routerState** (GoRouterState) - The current route state associated with route.
- **navigatorKey** (GlobalKey<NavigatorState>) - The Navigator key to be used for the nested navigation associated with route.
- **match** (ShellRouteMatch) - The ShellRouteMatch in routeMatchList that corresponds to the associated shell route.
- **routeMatchList** (RouteMatchList) - The route match list representing the current location within the associated shell route.
- **navigatorBuilder** (NavigatorBuilder) - Function used to build the Navigator for the current route.
```

--------------------------------

### ShellRoute Methods

Source: https://pub.dev/documentation/go_router/latest/go_router/ShellRoute-class.html

Methods for building pages and widgets, and managing navigator keys for sub-routes.

```APIDOC
## buildPage(BuildContext context, GoRouterState state, ShellRouteContext shellRouteContext)

### Description
Attempts to build the Page representing this shell route.

### Parameters
- **context** (BuildContext) - Required - The build context.
- **state** (GoRouterState) - Required - The current router state.
- **shellRouteContext** (ShellRouteContext) - Required - The shell route context.

---

## buildWidget(BuildContext context, GoRouterState state, ShellRouteContext shellRouteContext)

### Description
Attempts to build the Widget representing this shell route.

### Parameters
- **context** (BuildContext) - Required - The build context.
- **state** (GoRouterState) - Required - The current router state.
- **shellRouteContext** (ShellRouteContext) - Required - The shell route context.

---

## navigatorKeyForSubRoute(RouteBase subRoute)

### Description
Returns the key for the Navigator that is to be used for the specified immediate sub-route of this shell route.

### Parameters
- **subRoute** (RouteBase) - Required - The immediate sub-route.
```

--------------------------------

### Implement GoRouterState buildState Method

Source: https://pub.dev/documentation/go_router/latest/go_router/ImperativeRouteMatch/buildState.html

This method is used to get the state that represents the current route match. It requires a RouteConfiguration and a RouteMatchList.

```dart
@override
GoRouterState buildState(
  RouteConfiguration configuration,
  RouteMatchList matches,
) {
  return super.buildState(configuration, this.matches);
}
```

--------------------------------

### GoException Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/GoException/GoException.html

Creates an exception with a message describing the reason for the exception.

```APIDOC
## GoException Constructor

### Description
Creates an exception with message describing the reason.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **message** (String) - Required - The message describing the reason for the exception.

### Request Example
```json
{
  "message": "An error occurred."
}
```

### Response
#### Success Response (200)
- **GoException** (Object) - An instance of the GoException class.

#### Response Example
```json
{
  "message": "An error occurred."
}
```
```

--------------------------------

### TypedRoute Default Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/TypedRoute/TypedRoute.html

Use the default const constructor when defining a new TypedRoute. No specific setup is required beyond this declaration.

```dart
const TypedRoute();
```

--------------------------------

### Adding Diagnostic Properties

Source: https://pub.dev/documentation/go_router/latest/go_router/InheritedGoRouter/debugFillProperties.html

Examples of adding various property types to the diagnostic tree, including transforms, colors, and maps with custom descriptions.

```dart
properties.add(TransformProperty('transform', transform));
```

```dart
properties.add(DiagnosticsProperty<Color>('color', color));
```

```dart
properties.add(DiagnosticsProperty<Map<Listenable, VoidCallback>>(
  'handles',
  handles,
  description: handles != null
    ? '${handles!.length} active client${ handles!.length == 1 ? "" : "s" }'
    : null,
  ifNull: 'no notifications ever received',
  showName: false,
));
```

--------------------------------

### Get Current Index of StatefulShellBranch

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShellState/currentIndex.html

Retrieves the index of the currently active branch within a StatefulShellRoute. This property corresponds to the index in the branches field.

```dart
int get currentIndex => widget.currentIndex;
```

--------------------------------

### GoRoute Constructor Signature

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRoute/GoRoute.html

Defines the parameters for creating a GoRoute, including path, name, builder, pageBuilder, and redirect. Ensure path and name are not empty, and provide either a builder or pageBuilder.

```dart
GoRoute({
  1. required String path,
  2. String? name,
  3. GoRouterWidgetBuilder? builder,
  4. GoRouterPageBuilder? pageBuilder,
  5. GlobalKey<NavigatorState>? parentNavigatorKey,
  6. GoRouterRedirect? redirect,
  7. ExitCallback? onExit,
  8. bool caseSensitive = true,
  9. List<RouteBase> routes = const <RouteBase>[],
})

```

--------------------------------

### Get Matched Location String

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchBase/matchedLocation.html

Retrieve the location string that successfully matched the current route. This is the part of the URI that corresponds to the route definition.

```dart
String get matchedLocation;
```

--------------------------------

### GoRouter Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/GoRouter-class.html

Initializes the GoRouter with route definitions, error handlers, and navigation configuration.

```APIDOC
## GoRouter Constructor

### Description
Configures the GoRouter with a list of routes and optional handlers for redirection, errors, and navigation lifecycle events.

### Parameters
#### Request Body
- **routes** (List<RouteBase>) - Required - The top-level routes for the app.
- **onEnter** (OnEnter) - Optional - Callback to intercept navigation before routes are processed.
- **errorBuilder** (GoRouterWidgetBuilder) - Optional - Builder for the error screen when an exception occurs.
- **redirect** (GoRouterRedirect) - Optional - Callback to redirect to a new location.
- **redirectLimit** (int) - Optional - Maximum number of redirects allowed (default: 5).
- **refreshListenable** (Listenable) - Optional - Listenable to trigger a re-evaluation of the route configuration.
- **initialLocation** (String) - Optional - The initial location to navigate to.
- **requestFocus** (bool) - Optional - Whether to automatically request focus when new routes are pushed (default: true).
```

--------------------------------

### Accessing the Matched Route

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchBase/route.html

Use the 'route' property to get the currently matched route. This is typically accessed within route handlers or builders.

```dart
RouteBase get route;
```

--------------------------------

### RouteMatchBase Class Overview

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchBase-class.html

This snippet provides a detailed overview of the RouteMatchBase class, including its constructors, properties, methods, operators, and static methods.

```APIDOC
## RouteMatchBase Class

The base class for various route matches.

### Description
An abstract class that serves as the foundation for different types of route matches within the routing system. It is mixed-in with `Diagnosticable` and implemented by `RouteMatch` and `ShellRouteMatch`.

### Constructors

#### RouteMatchBase()
- Description: An abstract route match base.
- Signature: `RouteMatchBase()`

### Properties

- **hashCode** (`int`): The hash code for this object. (inherited)
- **matchedLocation** (`String`): The location string that matches the route.
- **pageKey** (`ValueKey<String>`): The page key.
- **route** (`RouteBase`): The matched route.
- **runtimeType** (`Type`): A representation of the runtime type of the object. (inherited)

### Methods

#### buildState
- Description: Gets the state that represents this route match.
- Signature: `buildState(RouteConfiguration configuration, RouteMatchList matches) → GoRouterState`

#### debugFillProperties
- Description: Add additional properties associated with the node.
- Signature: `debugFillProperties(DiagnosticPropertiesBuilder properties) → void` (override)

#### noSuchMethod
- Description: Invoked when a nonexistent method or property is accessed.
- Signature: `noSuchMethod(Invocation invocation) → dynamic` (inherited)

#### toDiagnosticsNode
- Description: Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
- Signature: `toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode` (inherited)

#### toString
- Description: A string representation of this object.
- Signature: `toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String` (inherited)

#### toStringShort
- Description: A brief description of this object, usually just the runtimeType and the hashCode.
- Signature: `toStringShort() → String` (inherited)

### Operators

#### operator ==
- Description: The equality operator.
- Signature: `operator ==(Object other) → bool` (inherited)

### Static Methods

#### match
- Description: Generates a list of RouteMatchBase objects by matching the `route` and its sub-routes with `uri`.
- Parameters:
  - **route** (`RouteBase`): Required - The route to match.
  - **pathParameters** (`Map<String, String>`): Required - A map of path parameters.
  - **rootNavigatorKey** (`GlobalKey<NavigatorState>`): Required - The key for the root navigator.
  - **uri** (`Uri`): Required - The URI to match against.
- Signature: `match({required RouteBase route, required Map<String, String> pathParameters, required GlobalKey<NavigatorState> rootNavigatorKey, required Uri uri}) → List<RouteMatchBase>`
```

--------------------------------

### Get redirectLimit Value

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteConfiguration/redirectLimit.html

Retrieves the current value of the redirectLimit from the routing configuration. This property limits the number of consecutive redirects to prevent loops.

```dart
int get redirectLimit => _routingConfig.value.redirectLimit;
```

--------------------------------

### build method

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBuilder/build.html

Builds the top-level Navigator for the given RouteMatchList.

```APIDOC
## build method

### Description
Builds the top-level Navigator for the given RouteMatchList. It handles empty match lists during async redirects and constructs a _CustomNavigator with the provided configuration.

### Parameters
- **context** (BuildContext) - Required - The build context.
- **matchList** (RouteMatchList) - Required - The list of route matches to build.
- **routerNeglect** (bool) - Required - Note: This parameter is currently unused and scheduled for removal in the next major version.
```

--------------------------------

### RoutingConfig Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/RoutingConfig/RoutingConfig.html

Initializes a new RoutingConfig instance with the required routes and optional redirect configurations.

```APIDOC
## RoutingConfig Constructor

### Description
Creates a routing configuration object. The routes list must not be empty.

### Parameters
#### Request Body
- **routes** (List<RouteBase>) - Required - A list of route definitions.
- **onEnter** (OnEnter?) - Optional - A callback triggered when entering the route.
- **redirect** (GoRouterRedirect) - Optional - A function to handle redirects. Defaults to _defaultRedirect.
- **redirectLimit** (int) - Optional - The maximum number of redirects allowed. Defaults to 5.

### Request Example
{
  "routes": ["..."],
  "onEnter": "callback_function",
  "redirect": "redirect_function",
  "redirectLimit": 5
}
```

--------------------------------

### Get StatefulNavigationShellState using of

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulNavigationShell-class.html

Retrieves the state for the nearest stateful shell route in the Widget tree. Throws an error if no stateful shell route is found.

```dart
StatefulNavigationShellState of(BuildContext context)
```

--------------------------------

### Initialize RouteBuilder

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBuilder/RouteBuilder.html

Constructor for creating a new RouteBuilder instance with required configuration and builder callbacks.

```dart
RouteBuilder({
  required this.configuration,
  required this.builderWithNav,
  required this.errorPageBuilder,
  required this.errorBuilder,
  required this.restorationScopeId,
  required this.observers,
  required this.onPopPageWithRouteMatch,
  this.requestFocus = true,
});
```

--------------------------------

### GET last property

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchList/last.html

Retrieves the last leaf route from the current matches. If the last match is a ShellRouteMatch, it recursively traverses the matches until the leaf is found.

```APIDOC
## GET last

### Description
Returns the last leaf route from the matches list. If the last match is a ShellRouteMatch, it recursively traverses the nested matches to find the leaf.

### Method
GET

### Endpoint
last

### Response
- **RouteMatch** (object) - The final leaf route match.

### Errors
- **StateError** - Thrown if the matches list is empty.
```

--------------------------------

### RouteMatchList Constructor

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteMatchList-class.html

Initializes a new instance of the RouteMatchList class.

```APIDOC
## RouteMatchList Constructor

### Description
Initializes a new instance of the RouteMatchList class.

### Parameters
- **matches** (List<RouteMatchBase>) - Required - The list of route matches.
- **uri** (Uri) - Required - The URI of the current match.
- **extra** (Object?) - Optional - An extra object to pass along with the navigation.
- **error** (GoException?) - Optional - An exception if there was an error during matching.
- **pathParameters** (Map<String, String>) - Required - Parameters for the matched route, URI-encoded.
```

--------------------------------

### Flatten routes recursively

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBase/routesRecursively.html

Use this method to get a flat list of all routes and their descendants. It takes an iterable of `RouteBase` and returns an iterable containing all routes.

```dart
static Iterable<RouteBase> routesRecursively(Iterable<RouteBase> routes) {
  return routes.expand(
    (RouteBase e) => <RouteBase>[e, ...routesRecursively(e.routes)],
  );
}
```

--------------------------------

### Adding diagnostic properties to a Flutter object

Source: https://pub.dev/documentation/go_router/latest/go_router/RouteBase/debugFillProperties.html

Examples of adding various property types to the diagnostic tree, including transforms, typed diagnostics, and custom descriptions.

```dart
properties.add(TransformProperty('transform', transform));

    // If the value class has a good `toString` method, use
    // DiagnosticsProperty<YourValueType>. Specifying the value type ensures
    // that debugging tools always know the type of the field and so can
    // provide the right UI affordances. For example, in this case even
    // if color is null, a debugging tool still knows the value is a Color
    // and can display relevant color related UI.
    properties.add(DiagnosticsProperty<Color>('color', color));

    // Use a custom description to generate a more terse summary than the
    // `toString` method on the map class.
    properties.add(DiagnosticsProperty<Map<Listenable, VoidCallback>>(
      'handles',
      handles,
      description: handles != null
        ? '${handles!.length} active client${ handles!.length == 1 ? "" : "s" }'
        : null,
      ifNull: 'no notifications ever received',
      showName: false,
    ));
  }
}
```

--------------------------------

### StatefulNavigationShell.goBranch

Source: https://pub.dev/documentation/go_router/latest/go_router/StatefulShellRoute-class.html

Method to switch the active navigation branch.

```APIDOC
## StatefulNavigationShell.goBranch

### Description
Switches the active branch, restoring the navigation stack of the target branch.

### Parameters
- **index** (int) - Required - The index of the branch to switch to.

### Request Example
void _onItemTapped(int index) {
  navigationShell.goBranch(index: index);
}
```

--------------------------------

### Declare GoRouter Property

Source: https://pub.dev/documentation/go_router/latest/go_router/InheritedGoRouter/goRouter.html

Declare the GoRouter property that will be made available to the widget tree. This is typically done at the top level of your application's routing setup.

```dart
final GoRouter goRouter;
```
Tokens:
Raw