flutter · NazarenoCavazzon · Jul 9, 2022 · Jul 9, 2022 · Jul 9, 2022 · Jul 9, 2022
@@ -1,16 +1,35 @@
-# go_router
+# go_router_flow
 
-A Declarative Routing Package for Flutter.
+This package was created for [SportsVisio's](https://sportsvisio.com/) apps, and it's currently in use and tested, and it'll be updated until the day go_router implements it.
 
-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.
+This is a fork of the go_router package that let's you communicate between pages by returning values on pop like in navigator 1.0. This was implemented by adding completers in the routes and waiting for the values when requested.
+
+## Returning values
+This is the reason for this package, to be able to return stuff when a screens pop.
+
+Waiting for a value to be returned:
+
+```dart
+onTap: () {
+  // In the new page you can do 'context.pop<bool>(someValue)' to return a value.
+  final bool? result = await context.push<bool>('/page2');
+
+  WidgetsBinding.instance.addPostFrameCallback((_) {
+    if(result ?? false)...
+  });
+}
+```
+
+Returning a value:
+
+```dart
+onTap: () => context.pop(true)
+```
 
 ## Getting Started
 
-Follow the [package install instructions](https://pub.dev/packages/go_router/install),
-and you can start using go_router in your app:
+Follow the [package install instructions](https://pub.dev/packages/go_router_flow/install),
+and you can start using go_router_flow in your app:
 
 ```dart
 import 'package:flutter/material.dart';
@@ -204,7 +223,7 @@ final  _router = GoRouter(
 For more details, see the
 [ShellRoute](https://pub.dev/documentation/go_router/latest/go_router/ShellRoute-class.html)
 API documentation. For a complete
-example, see the 
+example, see the
 [ShellRoute sample](https://github.com/flutter/packages/tree/main/packages/go_router/example/lib/shell_route.dart)
 in the example/ directory.
 

@@ -5,16 +5,16 @@
 import 'dart:async';
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 // This scenario demonstrates how to use redirect to handle a asynchronous
 // sign-in flow.
 //
 // The `StreamAuth` is a mock of google_sign_in. This example wraps it with an
 // InheritedNotifier, StreamAuthScope, and relies on
 // `dependOnInheritedWidgetOfExactType` to create a dependency between the
-// notifier and go_router's parsing pipeline. When StreamAuth broadcasts new
-// event, the dependency will cause the go_router to reparse the current url
+// notifier and go_router_flow's parsing pipeline. When StreamAuth broadcasts new
+// event, the dependency will cause the go_router_flow to reparse the current url
 // which will also trigger the redirect.
 
 void main() => runApp(StreamAuthScope(child: App()));
@@ -52,7 +52,7 @@ class App extends StatelessWidget {
     // redirect to the login page if the user is not logged in
     redirect: (BuildContext context, GoRouterState state) async {
       // Using `of` method creates a dependency of StreamAuthScope. It will
-      // cause go_router to reparse current route if StreamAuth has new sign-in
+      // cause go_router_flow to reparse current route if StreamAuth has new sign-in
       // information.
       final bool loggedIn = await StreamAuthScope.of(context).isSignedIn();
       final bool loggingIn = state.subloc == '/login';

@@ -4,7 +4,7 @@
 
 import 'package:collection/collection.dart';
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 import 'src/auth.dart';
 import 'src/data/author.dart';

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 import '../data.dart';
 import '../widgets/book_list.dart';

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 import '../data.dart';
 import '../widgets/author_list.dart';

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 import 'package:url_launcher/link.dart';
 
 import '../data.dart';

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 import '../data.dart';
 import '../widgets/book_list.dart';

@@ -5,7 +5,7 @@
 import 'package:adaptive_navigation/adaptive_navigation.dart';
 import 'package:flutter/material.dart';
 
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 /// The enum for scaffold tab.
 enum ScaffoldTab {

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 import 'package:url_launcher/link.dart';
 
 import '../auth.dart';

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 // This scenario demonstrates a simple two-page app.
 //

@@ -8,7 +8,7 @@
 import 'dart:convert';
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 // This scenario demonstrates how to navigate using named locations instead of
 // URLs.

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(App());
 

@@ -8,7 +8,7 @@
 import 'dart:convert';
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 final Map<String, dynamic> _families = const JsonDecoder().convert('''
 {

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(App());
 

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 import 'package:logging/logging.dart';
 
 void main() => runApp(App());

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(App());
 

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(App());
 

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(
       const RootRestorationScope(restorationId: 'root', child: App()),

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 void main() => runApp(App());
 

@@ -8,7 +8,7 @@
 import 'dart:convert';
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 // This scenario demonstrates how to use path parameters and query parameters.
 //

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 import 'package:provider/provider.dart';
 
 // This scenario demonstrates how to use redirect to handle a sign-in flow.

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 final GlobalKey<NavigatorState> _rootNavigatorKey =
     GlobalKey<NavigatorState>(debugLabel: 'root');

@@ -3,7 +3,7 @@
 // found in the LICENSE file.
 
 import 'package:flutter/material.dart';
-import 'package:go_router/go_router.dart';
+import 'package:go_router_flow/go_router.dart';
 
 // This scenario demonstrates an app with multi-level routing.
 //

@@ -14,7 +14,7 @@ dependencies:
   cupertino_icons: ^1.0.2
   flutter:
     sdk: flutter
-  go_router:
+  go_router_flow:
     path: ..
   logging: ^1.0.0
   package_info_plus: ^1.3.0

@@ -4,7 +4,7 @@
 
 /// A declarative router for Flutter based on Navigation 2 supporting
 /// deep linking, data-driven routes and more.
-library go_router;
+library go_router_flow;
 
 export 'src/configuration.dart'
     show GoRoute, GoRouterState, RouteBase, ShellRoute;

@@ -87,18 +87,24 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
     return navigator.maybePop();
   }
 
-  /// Pushes the given location onto the page stack
-  void push(RouteMatch match) {
+  /// Pushes the given location onto the page stack with an optional promise.
+  // Remap the pageKey to allow any number of the same page on the stack.
+  Future<T?> push<T extends Object?>(RouteMatch match) {
     if (match.route is ShellRoute) {
       throw GoError('ShellRoutes cannot be pushed');
     }
 
     // Remap the pageKey to allow any number of the same page on the stack
     final String fullPath = match.fullpath;
+
+    // Create a completer for the promise and store it in the completers map.
+    final Completer<T?> completer = Completer<T?>();
+
     final int count = (_pushCounts[fullPath] ?? 0) + 1;
     _pushCounts[fullPath] = count;
     final ValueKey<String> pageKey = ValueKey<String>('$fullPath-p$count');
     final RouteMatch newPageKeyMatch = RouteMatch(
+      completer: completer,
       route: match.route,
       subloc: match.subloc,
       fullpath: match.fullpath,
@@ -112,6 +118,7 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
 
     _matchList.push(newPageKeyMatch);
     notifyListeners();
+    return completer.future;
   }
 
   /// Returns `true` if the active Navigator can pop.
@@ -140,8 +147,16 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
     return navigatorKey.currentState?.canPop() ?? false;
   }
 
-  /// Pop the top page off the GoRouter's page stack.
-  void pop() {
+  /// Pop the top page off the GoRouter's page stack and complete a promise if
+  /// there is one.
+  void pop<T extends Object?>([T? value]) {
+    final RouteMatch last = _matchList.last;
+
+    // If there is a promise for this page, complete it.
+    if (last.completer != null) {
+      last.completer?.complete(value);
+    }
+
     _matchList.pop();
     notifyListeners();
   }
@@ -150,9 +165,11 @@ class GoRouterDelegate extends RouterDelegate<RouteMatchList>
   ///
   /// See also:
   /// * [push] which pushes the given location onto the page stack.
-  void replace(RouteMatch match) {
+  Future<T?>? replace<T extends Object?>(RouteMatch match) {
     _matchList.matches.last = match;
+
     notifyListeners();
+    return match.completer?.future as Future<T?>?;
   }
 
   /// For internal use; visible for testing only.

@@ -7,7 +7,7 @@ import 'package:flutter/services.dart';
 import 'package:flutter/widgets.dart';
 import 'parser.dart';
 
-/// The [RouteInformationProvider] created by go_router.
+/// The [RouteInformationProvider] created by go_router_flow.
 class GoRouteInformationProvider extends RouteInformationProvider
     with WidgetsBindingObserver, ChangeNotifier {
   /// Creates a [GoRouteInformationProvider].