diff --git a/packages/go_router_builder/CHANGELOG.md b/packages/go_router_builder/CHANGELOG.md index 13cb7d76ad6..7694ed991e2 100644 --- a/packages/go_router_builder/CHANGELOG.md +++ b/packages/go_router_builder/CHANGELOG.md @@ -1,3 +1,8 @@ +## 1.0.16 + +* Update the documentation to go_router v6.0.0. +* Bumps go_router version in example folder to v6.0.0. + ## 1.0.15 * Avoids using deprecated DartType.element2. diff --git a/packages/go_router_builder/README.md b/packages/go_router_builder/README.md index 73830a3c512..5d1db7a7f8f 100644 --- a/packages/go_router_builder/README.md +++ b/packages/go_router_builder/README.md @@ -85,7 +85,7 @@ class HomeRoute extends GoRouteData { const HomeRoute(); @override - Widget build(BuildContext context) => const HomeScreen(); + Widget build(BuildContext context, GoRouterState state) => const HomeScreen(); } ``` @@ -109,7 +109,7 @@ class HomeRoute extends GoRouteData { const HomeRoute(); @override - Widget build(BuildContext context) => HomeScreen(families: familyData); + Widget build(BuildContext context, GoRouterState state) => HomeScreen(families: familyData); } @TypedGoRoute(path: '/login') @@ -135,7 +135,7 @@ class ErrorRoute extends GoRouteData { final Exception error; @override - Widget build(BuildContext context) => ErrorScreen(error: error); + Widget build(BuildContext context, GoRouterState state) => ErrorScreen(error: error); } ``` @@ -175,7 +175,7 @@ class LoginRoute extends GoRouteData { final String? from; @override - Widget build(BuildContext context) => LoginScreen(from: from); + Widget build(BuildContext context, GoRouterState state) => LoginScreen(from: from); } ``` @@ -190,7 +190,7 @@ class PersonRouteWithExtra extends GoRouteData { final int? $extra; @override - Widget build(BuildContext context) => PersonScreen(personId: $extra); + Widget build(BuildContext context, GoRouterState state) => PersonScreen(personId: $extra); } ``` @@ -216,7 +216,7 @@ class HotdogRouteWithEverything extends GoRouteData { final Sauce $extra; // special $extra parameter @override - Widget build(BuildContext context) => HotdogScreen(ketchup, mustard, $extra); + Widget build(BuildContext context, GoRouterState state) => HotdogScreen(ketchup, mustard, $extra); } ``` @@ -245,7 +245,7 @@ Handle route-level redirects by implementing the `redirect` method on the route: class HomeRoute extends GoRouteData { // no need to implement [build] when this [redirect] is unconditional @override - String? redirect() => BooksRoute().location; + String? redirect(BuildContext context, GoRouterState state) => BooksRoute().location; } ``` @@ -262,7 +262,7 @@ class BooksRoute extends GoRouteData { final BookKind kind; @override - Widget build(BuildContext context) => BooksScreen(kind: kind); + Widget build(BuildContext context, GoRouterState state) => BooksScreen(kind: kind); } ``` @@ -279,14 +279,14 @@ of the page and the `restorationId` of the page. If you'd like to change how the page is created, e.g. to use a different page type, pass non-default parameters when creating the page (like a custom key) or -access the `GoRouteState` object, you can override the `buildPageWithState` +access the `GoRouteState` object, you can override the `buildPage` method of the base class instead of the `build` method: ```dart class MyMaterialRouteWithKey extends GoRouteData { static final _key = LocalKey('my-route-with-key'); @override - MaterialPage buildPageWithState(BuildContext context, GoRouterState state) => + MaterialPage buildPage(BuildContext context, GoRouterState state) => MaterialPage( key: _key, child: MyPage(), @@ -296,12 +296,12 @@ class MyMaterialRouteWithKey extends GoRouteData { ### Custom transitions -Overriding the `buildPageWithState` method is also useful for custom transitions: +Overriding the `buildPage` method is also useful for custom transitions: ```dart class FancyRoute extends GoRouteData { @override - MaterialPage buildPageWithState(BuildContext context, GoRouterState state) => + MaterialPage buildPage(BuildContext context, GoRouterState state) => CustomTransitionPage( key: state.pageKey, child: FancyPage(), diff --git a/packages/go_router_builder/example/lib/all_types.dart b/packages/go_router_builder/example/lib/all_types.dart index 8197697511a..606f5d28f89 100644 --- a/packages/go_router_builder/example/lib/all_types.dart +++ b/packages/go_router_builder/example/lib/all_types.dart @@ -30,7 +30,8 @@ class AllTypesBaseRoute extends GoRouteData { const AllTypesBaseRoute(); @override - Widget build(BuildContext context) => const BasePage( + Widget build(BuildContext context, GoRouterState state) => + const BasePage( dataTitle: 'Root', param: null, ); @@ -46,7 +47,7 @@ class BigIntRoute extends GoRouteData { final BigInt? bigIntField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'BigIntRoute', param: requiredBigIntField, queryParam: bigIntField, @@ -69,7 +70,7 @@ class BoolRoute extends GoRouteData { final bool? boolField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'BoolRoute', param: requiredBoolField, queryParam: boolField, @@ -92,7 +93,7 @@ class DateTimeRoute extends GoRouteData { final DateTime? dateTimeField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'DateTimeRoute', param: requiredDateTimeField, queryParam: dateTimeField, @@ -115,7 +116,7 @@ class DoubleRoute extends GoRouteData { final double? doubleField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'DoubleRoute', param: requiredDoubleField, queryParam: doubleField, @@ -138,7 +139,7 @@ class IntRoute extends GoRouteData { final int? intField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'IntRoute', param: requiredIntField, queryParam: intField, @@ -161,7 +162,7 @@ class NumRoute extends GoRouteData { final num? numField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'NumRoute', param: requiredNumField, queryParam: numField, @@ -184,7 +185,8 @@ class EnumRoute extends GoRouteData { final PersonDetails? enumField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => + BasePage( dataTitle: 'EnumRoute', param: requiredEnumField, queryParam: enumField, @@ -207,7 +209,8 @@ class EnhancedEnumRoute extends GoRouteData { final SportDetails? enumField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => + BasePage( dataTitle: 'EnhancedEnumRoute', param: requiredEnumField, queryParam: enumField, @@ -230,7 +233,7 @@ class StringRoute extends GoRouteData { final String? stringField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'StringRoute', param: requiredStringField, queryParam: stringField, @@ -253,7 +256,7 @@ class UriRoute extends GoRouteData { final Uri? uriField; @override - Widget build(BuildContext context) => BasePage( + Widget build(BuildContext context, GoRouterState state) => BasePage( dataTitle: 'UriRoute', param: requiredUriField, queryParam: uriField, diff --git a/packages/go_router_builder/example/lib/main.dart b/packages/go_router_builder/example/lib/main.dart index 8311655b74a..6d24c467e39 100644 --- a/packages/go_router_builder/example/lib/main.dart +++ b/packages/go_router_builder/example/lib/main.dart @@ -83,7 +83,7 @@ class HomeRoute extends GoRouteData { const HomeRoute(); @override - Widget build(BuildContext context) => const HomeScreen(); + Widget build(BuildContext context, GoRouterState state) => const HomeScreen(); } @TypedGoRoute( @@ -95,7 +95,8 @@ class LoginRoute extends GoRouteData { final String? fromPage; @override - Widget build(BuildContext context) => LoginScreen(from: fromPage); + Widget build(BuildContext context, GoRouterState state) => + LoginScreen(from: fromPage); } class FamilyRoute extends GoRouteData { @@ -104,7 +105,8 @@ class FamilyRoute extends GoRouteData { final String fid; @override - Widget build(BuildContext context) => FamilyScreen(family: familyById(fid)); + Widget build(BuildContext context, GoRouterState state) => + FamilyScreen(family: familyById(fid)); } class PersonRoute extends GoRouteData { @@ -114,7 +116,7 @@ class PersonRoute extends GoRouteData { final int pid; @override - Widget build(BuildContext context) { + Widget build(BuildContext context, GoRouterState state) { final Family family = familyById(fid); final Person person = family.person(pid); return PersonScreen(family: family, person: person); @@ -130,7 +132,7 @@ class PersonDetailsRoute extends GoRouteData { final int? $extra; @override - Page buildPageWithState(BuildContext context, GoRouterState state) { + Page buildPage(BuildContext context, GoRouterState state) { final Family family = familyById(fid); final Person person = family.person(pid); diff --git a/packages/go_router_builder/example/lib/simple_example.dart b/packages/go_router_builder/example/lib/simple_example.dart index 96574757957..6253fc6e9d1 100644 --- a/packages/go_router_builder/example/lib/simple_example.dart +++ b/packages/go_router_builder/example/lib/simple_example.dart @@ -36,7 +36,7 @@ class HomeRoute extends GoRouteData { const HomeRoute(); @override - Widget build(BuildContext context) => const HomeScreen(); + Widget build(BuildContext context, GoRouterState state) => const HomeScreen(); } class FamilyRoute extends GoRouteData { @@ -45,7 +45,7 @@ class FamilyRoute extends GoRouteData { final String familyId; @override - Widget build(BuildContext context) => + Widget build(BuildContext context, GoRouterState state) => FamilyScreen(family: familyById(familyId)); } diff --git a/packages/go_router_builder/example/pubspec.yaml b/packages/go_router_builder/example/pubspec.yaml index 71ec4780bbd..0b7ffcbff9d 100644 --- a/packages/go_router_builder/example/pubspec.yaml +++ b/packages/go_router_builder/example/pubspec.yaml @@ -8,7 +8,7 @@ environment: dependencies: flutter: sdk: flutter - go_router: ^5.0.0 + go_router: ^6.0.0 provider: ^6.0.0 dev_dependencies: diff --git a/packages/go_router_builder/pubspec.yaml b/packages/go_router_builder/pubspec.yaml index 60a2c3ebe2c..6e1083935e3 100644 --- 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: 1.0.15 +version: 1.0.16 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