[go_router] Add `TypedQueryParameter` annotation #10792

ValentinVignal · 2026-01-14T16:55:15Z

Adds TypedGoRouteParameter annotation

Pre-Review Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. 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.

Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩ ↩² ↩³

gemini-code-assist

Code Review

This pull request introduces the TypedGoRouteParameter annotation, which allows developers to customize URI parameter names in type-safe routes. The changes include the new annotation class, updates to the pubspec.yaml and CHANGELOG.md, and a unit test for the new class. My feedback focuses on ensuring the documentation for this new feature is clear and consistent with existing conventions.

packages/go_router/lib/src/route_data.dart

ValentinVignal · 2026-01-14T17:00:51Z

go_router_builder PR: #10793

chunhtai · 2026-01-30T23:54:08Z

packages/go_router/lib/src/route_data.dart

+  /// This will result in a route that matches
+  /// `/my-route?custom_name=some_value` instead of the default
+  /// `/my-route?my-parameter=some_value`.
+  final String? name;


as we discussed, can you add some documentation around escaped character

Sure, I added a sentence in fix changelog and add more doc. Is that okay for you?

chunhtai · 2026-01-30T23:54:45Z

packages/go_router/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 17.1.0


Suggested change

# 17.1.0

## 17.1.0

Fixed in fix changelog and add more doc

chunhtai

LGTM

hannah-hyj

LGTM

…ackages#10792)

flutter/packages@837dbbd...5b1bea8 2026-02-03 [email protected] [camera_avfoundation] handle interruptions and use single offset (flutter/packages#8982) 2026-02-03 [email protected] [go_router] Add `TypedQueryParameter` annotation (flutter/packages#10792) 2026-02-02 [email protected] [local_auth_darwin][UIScene] Add UIScene lifecycle support (flutter/packages#10836) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump camerax_version from 1.5.2 to 1.5.3 in /packages/camera/camera_android_camerax/android (flutter/packages#10946) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump gradle-wrapper from 8.13 to 9.3.1 in /packages/video_player/video_player/example/android/app (flutter/packages#10945) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump gradle-wrapper from 8.13 to 9.3.1 in /packages/local_auth/local_auth_android/example/android/app (flutter/packages#10941) 2026-02-02 [email protected] Roll Flutter from 9eafba4 to c305f1f (12 revisions) (flutter/packages#10956) 2026-02-02 [email protected] Roll Flutter from 1d9d6a9 to 9eafba4 (27 revisions) (flutter/packages#10938) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump org.json:json from 20250517 to 20251224 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#10949) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump the test-dependencies group across 2 directories with 1 update (flutter/packages#10944) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…mize parameter names (#10793) 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.

…er#181857) flutter/packages@837dbbd...5b1bea8 2026-02-03 [email protected] [camera_avfoundation] handle interruptions and use single offset (flutter/packages#8982) 2026-02-03 [email protected] [go_router] Add `TypedQueryParameter` annotation (flutter/packages#10792) 2026-02-02 [email protected] [local_auth_darwin][UIScene] Add UIScene lifecycle support (flutter/packages#10836) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump camerax_version from 1.5.2 to 1.5.3 in /packages/camera/camera_android_camerax/android (flutter/packages#10946) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump gradle-wrapper from 8.13 to 9.3.1 in /packages/video_player/video_player/example/android/app (flutter/packages#10945) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump gradle-wrapper from 8.13 to 9.3.1 in /packages/local_auth/local_auth_android/example/android/app (flutter/packages#10941) 2026-02-02 [email protected] Roll Flutter from 9eafba4 to c305f1f (12 revisions) (flutter/packages#10956) 2026-02-02 [email protected] Roll Flutter from 1d9d6a9 to 9eafba4 (27 revisions) (flutter/packages#10938) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump org.json:json from 20250517 to 20251224 in /packages/in_app_purchase/in_app_purchase_android/android (flutter/packages#10949) 2026-02-02 49699333+dependabot[bot]@users.noreply.github.com [dependabot]: Bump the test-dependencies group across 2 directories with 1 update (flutter/packages#10944) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

ValentinVignal requested a review from chunhtai as a code owner January 14, 2026 16:55

github-actions bot added p: go_router triage-framework Should be looked at in framework triage labels Jan 14, 2026

gemini-code-assist bot reviewed Jan 14, 2026

View reviewed changes

packages/go_router/lib/src/route_data.dart Outdated Show resolved Hide resolved

ValentinVignal mentioned this pull request Jan 14, 2026

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

Merged

11 tasks

ValentinVignal force-pushed the go-router/Add-typed-go-router-parameter branch from c704608 to ab858c7 Compare January 25, 2026 08:40

ValentinVignal changed the title ~~[go_router] Add TypedGoRouteParameter annotation~~ [go_router] Add TypedQueryParameter annotation Jan 25, 2026

ValentinVignal force-pushed the go-router/Add-typed-go-router-parameter branch from ab858c7 to acfcffe Compare January 25, 2026 08:53

github-actions bot added the p: go_router_builder label Jan 25, 2026

ValentinVignal force-pushed the go-router/Add-typed-go-router-parameter branch from acfcffe to da43e69 Compare January 25, 2026 08:55

github-actions bot removed the p: go_router_builder label Jan 25, 2026

ValentinVignal force-pushed the go-router/Add-typed-go-router-parameter branch from da43e69 to 6117e04 Compare January 27, 2026 08:43

chunhtai reviewed Jan 30, 2026

View reviewed changes

ValentinVignal added 6 commits February 1, 2026 18:30

Add TypedGoRouteParameter

03483cb

Update version and changelog

195141f

Add test

2d3393c

Fix comment

1bd918d

Rename to TypedQueryParameter

3947e59

fix changelog and add more doc

e53ebe5

ValentinVignal force-pushed the go-router/Add-typed-go-router-parameter branch from 6117e04 to e53ebe5 Compare February 1, 2026 10:33

ValentinVignal requested a review from chunhtai February 1, 2026 10:34

chunhtai approved these changes Feb 2, 2026

View reviewed changes

chunhtai requested a review from hannah-hyj February 2, 2026 18:01

hannah-hyj approved these changes Feb 2, 2026

View reviewed changes

ValentinVignal added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 3, 2026

auto-submit bot merged commit 2662b91 into flutter:main Feb 3, 2026
81 checks passed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 3, 2026

2662b91ee [go_router] Add TypedQueryParameter annotation (flutter/p…

e212d5e

…ackages#10792)

engine-flutter-autoroll mentioned this pull request Feb 3, 2026

Roll Packages from 837dbbdf62da to 2662b91ee941 (9 revisions) flutter/flutter#181855

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Feb 3, 2026

2662b91ee [go_router] Add TypedQueryParameter annotation (flutter/p…

ebbf135

…ackages#10792)

engine-flutter-autoroll mentioned this pull request Feb 3, 2026

Roll Packages from 837dbbdf62da to 5b1bea87e8b9 (10 revisions) flutter/flutter#181857

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[go_router] Add `TypedQueryParameter` annotation #10792

[go_router] Add `TypedQueryParameter` annotation #10792

ValentinVignal commented Jan 14, 2026

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

ValentinVignal commented Jan 14, 2026

Uh oh!

chunhtai Jan 30, 2026

Uh oh!

ValentinVignal Feb 1, 2026

Uh oh!

chunhtai Jan 30, 2026

Uh oh!

ValentinVignal Feb 1, 2026

Uh oh!

chunhtai left a comment

Uh oh!

hannah-hyj left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[go_router] Add TypedQueryParameter annotation #10792

[go_router] Add TypedQueryParameter annotation #10792

Conversation

ValentinVignal commented Jan 14, 2026

Pre-Review Checklist

Footnotes

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

ValentinVignal commented Jan 14, 2026

Uh oh!

chunhtai Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

ValentinVignal Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

chunhtai Jan 30, 2026

Choose a reason for hiding this comment

Uh oh!

ValentinVignal Feb 1, 2026

Choose a reason for hiding this comment

Uh oh!

chunhtai left a comment

Choose a reason for hiding this comment

Uh oh!

hannah-hyj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

[go_router] Add `TypedQueryParameter` annotation #10792

[go_router] Add `TypedQueryParameter` annotation #10792