add current state to router

packages/go_router/lib/src/delegate.dart

@@ -8,6 +8,7 @@ import 'dart:math' as math;
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 
+import '../go_router.dart';
 import 'builder.dart';
 import 'configuration.dart';
 import 'match.dart';
@@ -167,6 +168,10 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
     }());
   }
 
+  /// The current [GoRouterState]
+  GoRouterState? get currentState => currentConfiguration.last
+      .buildState(_configuration, currentConfiguration);
+
   /// For use by the Router architecture as part of the RouterDelegate.
   GlobalKey<NavigatorState> get navigatorKey => _configuration.navigatorKey;
 

packages/go_router/lib/src/router.dart

@@ -254,6 +254,9 @@ class GoRouter implements RouterConfig<RouteMatchList> {
     }());
   }
 
+  /// The current [GoRouterState].
+  GoRouterState? get currentState => routerDelegate.currentState;
+
   /// Whether the imperative API affects browser URL bar.
   ///
   /// The Imperative APIs refer to [push], [pushReplacement], or [replace].

packages/go_router/test/go_router_test.dart

@@ -5502,6 +5502,53 @@ void main() {
       ),
     );
   });
+
+  testWidgets(
+      'should return the current GoRouterState when router.currentState is called',
+      (WidgetTester tester) async {
+    final List<GoRoute> routes = <GoRoute>[
+      GoRoute(
+          name: 'home',
+          path: '/',
+          builder: (BuildContext context, GoRouterState state) =>
+              const HomeScreen()),
+      GoRoute(
+          name: 'books',
+          path: '/books',
+          builder: (BuildContext context, GoRouterState state) =>
+              const Text('books')),
+      GoRoute(
+          name: 'boats',
+          path: '/boats',
+          builder: (BuildContext context, GoRouterState state) =>
+              const Text('boats')),
+    ];
+
+    final GoRouter router = await createRouter(routes, tester);
+    await tester.pumpAndSettle();
+
+    GoRouterState? state = router.currentState;
+    expect(state?.name, 'home');
+    expect(state?.fullPath, '/');
+    router.go('/books');
+    await tester.pumpAndSettle();
+
+    state = router.currentState;
+    expect(state?.name, 'books');
+    expect(state?.fullPath, '/books');
+    router.push('/boats');
+    await tester.pumpAndSettle();
+
+    state = router.currentState;
+    expect(state?.name, 'boats');
+    expect(state?.fullPath, '/boats');
+    router.pop();
+    await tester.pumpAndSettle();
+
+    state = router.currentState;
+    expect(state?.name, 'books');
+    expect(state?.fullPath, '/books');
+  });
 }
 
 class TestInheritedNotifier extends InheritedNotifier<ValueNotifier<String>> {