[go_router_builder] Add support for @TypedGoRouteParameter to customize parameter names (#10793)

ValentinVignal · web-flow · commit df85ef0f4c60 · 2026-02-04T01:56:38.000Z
Relates to flutter/flutter#112152 Add support for `@TypedGoRouteParameter` to customize parameter names Needs #10792 to get merged first ## Pre-Review Checklist **Note**: The Flutter team is currently trialing the use of [Gemini Code Assist for GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code). Comments from the `gemini-code-assist` bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed. [^1]: Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling.
diff --git a/packages/go_router_builder/CHANGELOG.md b/packages/go_router_builder/CHANGELOG.md
@@ -1,3 +1,8 @@
+## 4.2.0
+
+- Adds supports for `TypedQueryParameter` annotation.
+  Its `name` parameter allows specifying a different name for the query parameter than the field name. The name is escaped to be URL-safe. For example `@TypedQueryParameter(name: 'field with space')` will generate a query parameter named `field+with+space`.
+
 ## 4.1.3
 
 * Requires `analyzer` 8.2 or higher, to avoid experimental APIs.
diff --git a/packages/go_router_builder/example/lib/typed_query_parameter_example.dart b/packages/go_router_builder/example/lib/typed_query_parameter_example.dart
@@ -0,0 +1,111 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// ignore_for_file: public_member_api_docs
+
+import 'package:flutter/material.dart';
+import 'package:go_router/go_router.dart';
+
+part 'typed_query_parameter_example.g.dart';
+
+void main() => runApp(App());
+
+class App extends StatelessWidget {
+  App({super.key});
+
+  @override
+  Widget build(BuildContext context) =>
+      MaterialApp.router(routerConfig: _router);
+
+  final GoRouter _router = GoRouter(
+    initialLocation: '/int-route',
+    routes: $appRoutes,
+  );
+}
+
+@TypedGoRoute<IntRoute>(path: '/int-route')
+class IntRoute extends GoRouteData with $IntRoute {
+  IntRoute({
+    @TypedQueryParameter(name: 'intField') this.intField,
+    @TypedQueryParameter(name: 'int_field_with_default_value')
+    this.intFieldWithDefaultValue = 1,
+    @TypedQueryParameter(name: 'int field') this.intFieldWithSpace,
+  });
+
+  final int? intField;
+  final int intFieldWithDefaultValue;
+  final int? intFieldWithSpace;
+  @override
+  Widget build(BuildContext context, GoRouterState state) => Screen(
+    intField: intField,
+    intFieldWithDefaultValue: intFieldWithDefaultValue,
+    intFieldWithSpace: intFieldWithSpace,
+  );
+}
+
+class Screen extends StatelessWidget {
+  const Screen({
+    required this.intField,
+    required this.intFieldWithDefaultValue,
+    this.intFieldWithSpace,
+    super.key,
+  });
+
+  final int? intField;
+  final int intFieldWithDefaultValue;
+  final int? intFieldWithSpace;
+
+  @override
+  Widget build(BuildContext context) => Scaffold(
+    appBar: AppBar(
+      title: const Text('Go router with custom URI parameter names'),
+    ),
+    body: Center(
+      child: Column(
+        mainAxisSize: MainAxisSize.min,
+        children: <Widget>[
+          ListTile(
+            title: const Text('intField:'),
+            subtitle: Text('$intField'),
+            trailing: const Icon(Icons.add),
+            onTap: () {
+              final int newValue = (intField ?? 0) + 1;
+              IntRoute(
+                intField: newValue,
+                intFieldWithDefaultValue: intFieldWithDefaultValue,
+                intFieldWithSpace: intFieldWithSpace,
+              ).go(context);
+            },
+          ),
+          ListTile(
+            title: const Text('intFieldWithDefaultValue:'),
+            subtitle: Text('$intFieldWithDefaultValue'),
+            trailing: const Icon(Icons.add),
+            onTap: () {
+              final int newValue = intFieldWithDefaultValue + 1;
+              IntRoute(
+                intField: intField,
+                intFieldWithDefaultValue: newValue,
+                intFieldWithSpace: intFieldWithSpace,
+              ).go(context);
+            },
+          ),
+          ListTile(
+            title: const Text('intFieldWithSpace:'),
+            subtitle: Text('$intFieldWithSpace'),
+            trailing: const Icon(Icons.add),
+            onTap: () {
+              final int newValue = (intFieldWithSpace ?? 0) + 1;
+              IntRoute(
+                intField: intField,
+                intFieldWithDefaultValue: intFieldWithDefaultValue,
+                intFieldWithSpace: newValue,
+              ).go(context);
+            },
+          ),
+        ],
+      ),
+    ),
+  );
+}
diff --git a/packages/go_router_builder/example/lib/typed_query_parameter_example.g.dart b/packages/go_router_builder/example/lib/typed_query_parameter_example.g.dart
diff --git a/packages/go_router_builder/example/pubspec.yaml b/packages/go_router_builder/example/pubspec.yaml
@@ -9,7 +9,7 @@ dependencies:
   collection: ^1.15.0
   flutter:
     sdk: flutter
-  go_router: ^16.2.0
+  go_router: ^17.1.0
   provider: 6.0.5
 
 dev_dependencies:
diff --git a/packages/go_router_builder/example/test/typed_query_parameter_test.dart b/packages/go_router_builder/example/test/typed_query_parameter_test.dart
@@ -0,0 +1,43 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:go_router_builder_example/typed_query_parameter_example.dart';
+
+void main() {
+  testWidgets('It should increase the counts when pressed', (tester) async {
+    await tester.pumpWidget(App());
+
+    expect(
+      find.text('null'),
+      findsExactly(2),
+      reason: 'intField and intFieldWithSpace are both null',
+    );
+    expect(find.text('1'), findsOne);
+
+    await tester.tap(find.text('intField:'));
+    await tester.pumpAndSettle();
+    expect(
+      find.text('1'),
+      findsExactly(2),
+      reason: 'intField and intFieldWithDefaultValue are both 1',
+    );
+    expect(find.text('null'), findsOne);
+
+    await tester.tap(find.text('intFieldWithDefaultValue:'));
+    await tester.pumpAndSettle();
+    expect(find.text('1'), findsOne);
+    expect(find.text('2'), findsOne);
+    expect(find.text('null'), findsOne);
+
+    await tester.tap(find.text('intFieldWithSpace:'));
+    await tester.pumpAndSettle();
+    expect(
+      find.text('1'),
+      findsExactly(2),
+      reason: 'intField and intFieldWithSpace are both 1',
+    );
+    expect(find.text('2'), findsOne);
+  });
+}
diff --git a/packages/go_router_builder/lib/src/route_config.dart b/packages/go_router_builder/lib/src/route_config.dart
@@ -318,7 +318,6 @@ mixin _GoRouteMixin on RouteBaseConfig {
 
     for (final FormalParameterElement param in _ctorQueryParams) {
       final String parameterName = param.displayName;
-
       final conditions = <String>[];
       if (param.hasDefaultValue) {
         if (param.type.isNullableType) {
@@ -335,7 +334,7 @@ mixin _GoRouteMixin on RouteBaseConfig {
         line = 'if (${conditions.join(' && ')}) ';
       }
       line +=
-          '${escapeDartString(parameterName.kebab)}: '
+          '${param.uriName}: '
           '${_encodeFor(parameterName)},';
 
       buffer.writeln(line);
diff --git a/packages/go_router_builder/lib/src/type_helpers.dart b/packages/go_router_builder/lib/src/type_helpers.dart
@@ -244,8 +244,7 @@ String _stateValueAccess(
   if (pathParameters.contains(element.displayName)) {
     access = 'pathParameters[${escapeDartString(element.displayName)}]$suffix';
   } else {
-    access =
-        'uri.queryParameters[${escapeDartString(element.displayName.kebab)}]$suffix';
+    access = 'uri.queryParameters[${element.uriName}]$suffix';
   }
 
   return access;
@@ -635,11 +634,11 @@ class _TypeHelperIterable extends _TypeHelperWithHelper {
 
       return '''
 state.uri.queryParametersAll[
-        ${escapeDartString(parameterElement.displayName.kebab)}]
+        ${parameterElement.uriName}]
         ?.map($entriesTypeDecoder)$convertToNotNull$iterableCaster$fallBack''';
     }
     return '''
-state.uri.queryParametersAll[${escapeDartString(parameterElement.displayName.kebab)}]''';
+state.uri.queryParametersAll[${parameterElement.uriName}]''';
   }
 
   @override
@@ -822,7 +821,7 @@ abstract class _TypeHelperWithHelper extends _TypeHelper {
     if (!pathParameters.contains(parameterName) &&
         (paramType.isNullableType || parameterElement.hasDefaultValue)) {
       return '$convertMapValueHelperName('
-          '${escapeDartString(parameterName.kebab)}, '
+          '${parameterElement.uriName}, '
           'state.uri.queryParameters, '
           '${helperName(paramType)})';
     }
@@ -853,6 +852,18 @@ extension FormalParameterElementExtension on FormalParameterElement {
 
   /// Returns `true` if `this` has a name that matches [extraFieldName];
   bool get isExtraField => displayName == extraFieldName;
+
+  /// Returns the URI name for this parameter, taking into account any
+  /// `TypedQueryParameter` annotation that may override the name.
+  String get uriName {
+    final typedQueryParameterReader = ConstantReader(
+      _typedQueryParameterChecker.firstAnnotationOf(this),
+    );
+    final String name =
+        typedQueryParameterReader.peek('name')?.stringValue ??
+        displayName.kebab;
+    return escapeDartString(name);
+  }
 }
 
 /// An error thrown when a default value is used with a nullable type.
@@ -865,3 +876,7 @@ class NullableDefaultValueError extends InvalidGenerationSourceError {
         element: element,
       );
 }
+
+const _typedQueryParameterChecker = TypeChecker.fromUrl(
+  'package:go_router/src/route_data.dart#TypedQueryParameter',
+);
diff --git a/packages/go_router_builder/pubspec.yaml b/packages/go_router_builder/pubspec.yaml
@@ -2,7 +2,7 @@ name: go_router_builder
 description: >-
   A builder that supports generated strongly-typed route helpers for
   package:go_router
-version: 4.1.3
+version: 4.2.0
 repository: https://github.com/flutter/packages/tree/main/packages/go_router_builder
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router_builder%22
 
@@ -27,7 +27,7 @@ dev_dependencies:
   dart_style: ">=2.3.7 <4.0.0"
   flutter:
     sdk: flutter
-  go_router: ^16.2.0
+  go_router: ^17.1.0
   leak_tracker_flutter_testing: ">=3.0.0"
   package_config: ^2.1.1
   pub_semver: ^2.1.5
diff --git a/packages/go_router_builder/test_inputs/typed_query_parameter.dart b/packages/go_router_builder/test_inputs/typed_query_parameter.dart
@@ -0,0 +1,18 @@
+// Copyright 2013 The Flutter Authors
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:go_router/go_router.dart';
+
+mixin $OverriddenParameterNameRoute {}
+
+@TypedGoRoute<OverriddenParameterNameRoute>(path: '/typed-go-route-parameter')
+class OverriddenParameterNameRoute extends GoRouteData
+    with $OverriddenParameterNameRoute {
+  OverriddenParameterNameRoute({
+    @TypedQueryParameter(name: 'parameterNameOverride') this.withAnnotation,
+    @TypedQueryParameter(name: 'name with space') this.withSpace,
+  });
+  final int? withAnnotation;
+  final String? withSpace;
+}
diff --git a/packages/go_router_builder/test_inputs/typed_query_parameter.dart.expect b/packages/go_router_builder/test_inputs/typed_query_parameter.dart.expect
