Skip to content

Update go_router type safe route docs to reflect that the generated mixins are now public #11814

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LiamKearn wants to merge 1 commit into
base: main
Choose a base branch
from
+2 −2
Open

Update go_router type safe route docs to reflect that the generated mixins are now public #11814

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/go_router/doc/type-safe-routes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ part 'go_router_builder.g.dart';
]
)
@immutable
class HomeScreenRoute extends GoRouteData with _$HomeScreenRoute {

@chunhtai chunhtai Jun 11, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As @stuartmorgan-g mentioned, we should convert this to excerpt.

See example in

packages/packages/go_router/doc/configuration.md

Line 170 in cb70d4e

<?code-excerpt "../example/lib/stateful_shell_route.dart (configuration-branches)"?>

class HomeScreenRoute extends GoRouteData with $HomeScreenRoute {
@override
Widget build(BuildContext context, GoRouterState state) {
return const HomeScreen();
}
}

@immutable
class SongRoute extends GoRouteData with _$SongRoute {
class SongRoute extends GoRouteData with $SongRoute {
final int id;

const SongRoute({
Expand Down