From 43189d90f88e2f9efea379d1c694dede6e9e9bb1 Mon Sep 17 00:00:00 2001 From: John Ryan Date: Thu, 11 Feb 2021 08:59:55 -0800 Subject: [PATCH] Rename Navigator 2.0 to Router (#712) * Rename Navigator 2.0 to Router This aligns better with the documentation for this new API, and doesn't imply that apps need to be upgraded. * introduction -> navigator --- navigation_and_routing/README.md | 36 +++++++++---------- .../anonymous_routes.dart | 0 .../{nav_1 => navigator}/named_routes.dart | 0 .../on_generate_route.dart | 0 .../lib/{nav_2 => router}/pages.dart | 0 .../lib/{nav_2 => router}/router.dart | 0 .../nested_router.dart | 0 .../transition_delegate.dart | 2 +- 8 files changed, 18 insertions(+), 20 deletions(-) rename navigation_and_routing/lib/{nav_1 => navigator}/anonymous_routes.dart (100%) rename navigation_and_routing/lib/{nav_1 => navigator}/named_routes.dart (100%) rename navigation_and_routing/lib/{nav_1 => navigator}/on_generate_route.dart (100%) rename navigation_and_routing/lib/{nav_2 => router}/pages.dart (100%) rename navigation_and_routing/lib/{nav_2 => router}/router.dart (100%) rename navigation_and_routing/lib/{nav_2_advanced => router_advanced}/nested_router.dart (100%) rename navigation_and_routing/lib/{nav_2_advanced => router_advanced}/transition_delegate.dart (99%) diff --git a/navigation_and_routing/README.md b/navigation_and_routing/README.md index 030715757..d8ed4ab5c 100644 --- a/navigation_and_routing/README.md +++ b/navigation_and_routing/README.md @@ -1,49 +1,47 @@ # Navigation and Routing sample code Sample code for [Learning Flutter's New Navigation and Routing System][article], -an article explaining Navigator 2.0. +an article explaining the Router widget and it's associated classes. ## Samples -**Navigator 1.0 samples** +**Navigator samples** -* [nav_1/anonymous_routes.dart](lib/nav_1/anonymous_routes.dart) - Shows how to - use a Navigator to push and pop anonymous routes (e.g. MaterialPageRoute) -* [nav_1/named_routes.dart](lib/nav_1/named_routes.dart) - Shows how to use - define named routes via the `routes` parameter on MaterialApp, and navigate - using Navigator.pushNamed -* [nav_1/on_generate_route.dart](lib/nav_1/on_generate_route.dart) - Shows how - to handle arbitrary named routes using the `onGenerateRoute` callback defined - in the `MaterialApp` constructor. +* [navigator/anonymous_routes.dart](lib/navigator/anonymous_routes.dart) - + Shows how to use a Navigator to push and pop anonymous routes (e.g. + MaterialPageRoute) +* [navigator/named_routes.dart](lib/navigator/named_routes.dart) - Shows + how to use define named routes via the `routes` parameter on MaterialApp, and + navigate using Navigator.pushNamed +* [navigator/on_generate_route.dart](lib/navigator/on_generate_route.dart) - + Shows how to handle arbitrary named routes using the `onGenerateRoute` + callback defined in the `MaterialApp` constructor. -**Navigator 2.0 samples** +**Router samples** -* [nav_2/pages.dart](lib/nav_2/pages.dart) - Shows how to define a list of +* [router/pages.dart](lib/router/pages.dart) - Shows how to define a list of [Page] objects on Navigator declaratively. -* [nav_2/router.dart](lib/nav_2/router.dart) - Full sample that shows a custom +* [router/router.dart](lib/router/router.dart) - Full sample that shows a custom RouteInformationParser and RouterDelegate parsing named routes and declaratively building the stack of pages for the Navigator. - **Advanced** -* [nav_2_advanced/nested_router.dart](lib/nav_2_advanced/nested_router.dart) - +* [router_advanced/nested_router.dart](lib/router_advanced/nested_router.dart) - Shows two [RouterDelegate], one nested within the other. A [BottomNavigationBar] can be used to select the route of the outer RouterDelegate, and additional routes can be pushed onto the inner RouterDelegate / Navigator. -* [nav_2_advanced/transition_delegate.dart](lib/nav_2_advanced/transition_delegate.dart) +* [router_advanced/transition_delegate.dart](lib/router_advanced/transition_delegate.dart) Shows how a custom TransitionDelegate can be used to customized when transition animations are shown. - ## Running Each file in this project is an entrypoint. To run, specify the filename of the sample: ```bash -flutter run lib/nav_2/router.dart +flutter run lib/router/router.dart ``` - [article]: https://medium.com/flutter/learning-flutters-new-navigation-and-routing-system-7c9068155ade diff --git a/navigation_and_routing/lib/nav_1/anonymous_routes.dart b/navigation_and_routing/lib/navigator/anonymous_routes.dart similarity index 100% rename from navigation_and_routing/lib/nav_1/anonymous_routes.dart rename to navigation_and_routing/lib/navigator/anonymous_routes.dart diff --git a/navigation_and_routing/lib/nav_1/named_routes.dart b/navigation_and_routing/lib/navigator/named_routes.dart similarity index 100% rename from navigation_and_routing/lib/nav_1/named_routes.dart rename to navigation_and_routing/lib/navigator/named_routes.dart diff --git a/navigation_and_routing/lib/nav_1/on_generate_route.dart b/navigation_and_routing/lib/navigator/on_generate_route.dart similarity index 100% rename from navigation_and_routing/lib/nav_1/on_generate_route.dart rename to navigation_and_routing/lib/navigator/on_generate_route.dart diff --git a/navigation_and_routing/lib/nav_2/pages.dart b/navigation_and_routing/lib/router/pages.dart similarity index 100% rename from navigation_and_routing/lib/nav_2/pages.dart rename to navigation_and_routing/lib/router/pages.dart diff --git a/navigation_and_routing/lib/nav_2/router.dart b/navigation_and_routing/lib/router/router.dart similarity index 100% rename from navigation_and_routing/lib/nav_2/router.dart rename to navigation_and_routing/lib/router/router.dart diff --git a/navigation_and_routing/lib/nav_2_advanced/nested_router.dart b/navigation_and_routing/lib/router_advanced/nested_router.dart similarity index 100% rename from navigation_and_routing/lib/nav_2_advanced/nested_router.dart rename to navigation_and_routing/lib/router_advanced/nested_router.dart diff --git a/navigation_and_routing/lib/nav_2_advanced/transition_delegate.dart b/navigation_and_routing/lib/router_advanced/transition_delegate.dart similarity index 99% rename from navigation_and_routing/lib/nav_2_advanced/transition_delegate.dart rename to navigation_and_routing/lib/router_advanced/transition_delegate.dart index 9329a6b5b..dc40a9183 100644 --- a/navigation_and_routing/lib/nav_2_advanced/transition_delegate.dart +++ b/navigation_and_routing/lib/router_advanced/transition_delegate.dart @@ -5,7 +5,7 @@ /// Shows how a custom TransitionDelegate can be used to customized when /// transition animations are shown. (For example, [when two routes are popped /// off the stack](https://github.com/flutter/flutter/issues/12146), however the -/// default TransitionDelegate will handle this if you are using Navigator 2.0) +/// default TransitionDelegate will handle this if you are using Router) import 'package:flutter/material.dart'; void main() {