add comment

flutter · Nov 3, 2024 · af41cd5 · af41cd5
1 parent ca30f19
commit af41cd5
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/go_router/lib/src/router.dart b/packages/go_router/lib/src/router.dart
@@ -257,6 +257,10 @@ class GoRouter implements RouterConfig<RouteMatchList> {
 
   /// The top [GoRouterState], the state of the route that was
   /// last used in either [GoRouter.go] or [GoRouter.push].
+  ///
+  /// Accessing this property via GoRouter.of(context).state will not
+  /// cause rebuild if the state has changed, consider using
+  /// GoRouterState.of(context) instead.
   GoRouterState? get state => routerDelegate.state;
 
   /// Whether the imperative API affects browser URL bar.