Merge tag 'go_router-v4.2.7' into go-router/allow-list-of-query-parameters

ValentinVignal · ValentinVignal · commit 13e6cb15b226 · 2022-08-04T09:11:21.000+08:00
# Conflicts:
#	packages/go_router/CHANGELOG.md
#	packages/go_router/pubspec.yaml
diff --git a/.ci/flutter_master.version b/.ci/flutter_master.version
@@ -1 +1 @@
-708d2121cbcfa92008cd7e47657fdcf170382941
+183d3e410102f4347eedce60950379d86991323a
diff --git a/packages/go_router/CHANGELOG.md b/packages/go_router/CHANGELOG.md
@@ -1,7 +1,15 @@
-## 4.2.6
+## 4.2.8
 
 - Allows `Map<String, dynamic>` maps as `queryParams` of `goNamed`, `replacedName`, `pushNamed` and `namedLocation`. 
 
+## 4.2.7
+
+- Update README
+
+## 4.2.6
+
+- Fixes rendering issues in the README.
+
 ## 4.2.5
 
 - Fixes a bug where calling extra parameter is always null in route level redirect callback
diff --git a/packages/go_router/README.md b/packages/go_router/README.md
@@ -1,36 +1,49 @@
-# go_router, A Declarative Routing Package for Flutter
+# go_router
 
-This package builds on top of the Flutter framework's Router API and provides
-convenient url-based APIs to navigate between different screens. You can
-define your own url patterns, navigating to different url, handle deep and
-dynamic linking, and a number of other navigation-related scenarios.
+A Declarative Routing Package for Flutter.
+
+This package uses the Flutter framework's Router API to provide a
+convenient, url-based API for navigating between different screens. You can
+define URL patterns, navigate using a URL, handle deep links,
+and a number of other navigation-related scenarios.
 
 ## Getting Started
 
 Follow the [package install instructions](https://pub.dev/packages/go_router/install),
-and you can start using go_router in your code:
+and you can start using go_router in your app:
 
 ```dart
+import 'package:flutter/material.dart';
+import 'package:go_router/go_router.dart';
+
+void main() => runApp(App());
+
 class App extends StatelessWidget {
   App({Key? key}) : super(key: key);
 
   @override
-  Widget build(BuildContext context) => MaterialApp.router(
-        routeInformationProvider: _router.routeInformationProvider,
-        routeInformationParser: _router.routeInformationParser,
-        routerDelegate: _router.routerDelegate,
-        title: 'GoRouter Example',
-      );
+  Widget build(BuildContext context) {
+    return MaterialApp.router(
+      routeInformationProvider: _router.routeInformationProvider,
+      routeInformationParser: _router.routeInformationParser,
+      routerDelegate: _router.routerDelegate,
+      title: 'GoRouter Example',
+    );
+  }
 
   final GoRouter _router = GoRouter(
     routes: <GoRoute>[
       GoRoute(
         path: '/',
-        builder: (BuildContext context, GoRouterState state) => const Page1Screen(),
+        builder: (BuildContext context, GoRouterState state) {
+          return ScreenA();
+        },
       ),
       GoRoute(
-        path: '/page2',
-        builder: (BuildContext context, GoRouterState state) => const Page2Screen(),
+        path: '/b',
+        builder: (BuildContext context, GoRouterState state) {
+          return ScreenB();
+        },
       ),
     ],
   );
@@ -39,7 +52,7 @@ class App extends StatelessWidget {
 
 ## Define Routes
 
-go_router is governed by a set of routes which are specify as part of the
+go_router is governed by a set of routes which are specified as part of the
 [GoRouter](https://pub.dev/documentation/go_router/latest/go_router/GoRouter-class.html)
 constructor:
 
@@ -58,27 +71,33 @@ GoRouter(
 );
 ```
 
-It defined two routes, `/` and `/page2`. Each route path will be matched against
-the location to which the user is navigating. The path will be matched in a
-case-insensitive way, although the case for parameters will be preserved. If
-there are multiple route matches, the <b>first</b> match in the list takes priority
-over the others.
-
-In addition to the path, each route will typically have a [builder](https://pub.dev/documentation/go_router/latest/go_router/GoRoute/builder.html)
-function that is responsible for building the `Widget` that is to take up the
-entire screen of the app. The default transition is used between pages
+In the above snippet, two routes are defined, `/` and `/page2`.
+When the URL changes, it is matched against each route path.
+The path is matched in a case-insensitive way, but the case for 
+parameters is preserved. If there are multiple route matches, 
+the **first match** in the list takes priority over the others.
+
+The [builder](https://pub.dev/documentation/go_router/latest/go_router/GoRoute/builder.html)
+is responsible for building the `Widget` to display on screen.
+Alternatively, you can use `pageBuilder` to customize the transition 
+animation when that route becomes active.
+The default transition is used between pages
 depending on the app at the top of its widget tree, e.g. the use of `MaterialApp`
 will cause go_router to use the `MaterialPage` transitions. Consider using
 [pageBuilder](https://pub.dev/documentation/go_router/latest/go_router/GoRoute/pageBuilder.html)
 for custom `Page` class.
 
 ## Initalization
 
-Once a [GoRouter](https://pub.dev/documentation/go_router/latest/go_router/GoRouter-class.html)
-object is created, it can be used to initialize `MaterialApp` or `CupertinoApp`.
+Create a [GoRouter](https://pub.dev/documentation/go_router/latest/go_router/GoRouter-class.html)
+object and initialize your `MaterialApp` or `CupertinoApp`:
 
 ```dart
-final GoRouter _router = GoRouter(..);
+final GoRouter _router = GoRouter(
+  routes: <GoRoute>[
+     // ...
+  ]
+);
 
 MaterialApp.router(
   routeInformationProvider: _router.routeInformationProvider,
@@ -108,24 +127,23 @@ To navigate between routes, use the [GoRouter.go](https://pub.dev/documentation/
 onTap: () => GoRouter.of(context).go('/page2')
 ```
 
-go_router also provides a simplified means of navigation using Dart extension
+go_router also provides a more concise way to navigate using Dart extension
 methods:
 
 ```dart
 onTap: () => context.go('/page2')
 ```
 
-<br>
-
-### Still not sure how to proceed? See [examples](https://github.com/flutter/packages/tree/main/packages/go_router/example) for complete runnable examples or visit [API documentation](https://pub.dev/documentation/go_router/latest/go_router/go_router-library.html)
+### Still not sure how to proceed?
+See [examples](https://github.com/flutter/packages/tree/main/packages/go_router/example) for complete runnable examples or visit [API documentation](https://pub.dev/documentation/go_router/latest/go_router/go_router-library.html)
 
 
 ## Migration guides
 
-[Migrating to 2.0](https://flutter.dev/go/go-router-v2-breaking-changes)<br/>
-[Migrating to 2.5](https://flutter.dev/go/go-router-v2-5-breaking-changes)<br/>
-[Migrating to 3.0](https://flutter.dev/go/go-router-v3-breaking-changes)<br/>
-[Migrating to 4.0](https://flutter.dev/go/go-router-v4-breaking-changes)<br/>
+- [Migrating to 2.0](https://flutter.dev/go/go-router-v2-breaking-changes)
+- [Migrating to 2.5](https://flutter.dev/go/go-router-v2-5-breaking-changes)
+- [Migrating to 3.0](https://flutter.dev/go/go-router-v3-breaking-changes)
+- [Migrating to 4.0](https://flutter.dev/go/go-router-v4-breaking-changes)
 
 ## Changelog
 
diff --git a/packages/go_router/pubspec.yaml b/packages/go_router/pubspec.yaml
@@ -1,7 +1,7 @@
 name: go_router
 description: A declarative router for Flutter based on Navigation 2 supporting
   deep linking, data-driven routes and more
-version: 4.2.6
+version: 4.2.8
 repository: https://github.com/flutter/packages/tree/main/packages/go_router
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+go_router%22
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-708d2121cbcfa92008cd7e47657fdcf170382941`
	`1`	`+183d3e410102f4347eedce60950379d86991323a`