Renamed Router class to MomentumRouter #31

xamantra · Jan 8, 2021 · a3b941a · a3b941a
1 parent 5b4d1f6
commit a3b941a
Show file tree

Hide file tree

Showing 24 changed files with 225 additions and 219 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,4 @@ doc/api/
 /.idea/dictionaries/xamantra.xml
 example/lib/temp.dart
 CODECOV_TOKEN
+sandbox/
diff --git a/coverage/lcov.info b/coverage/lcov.info
@@ -549,115 +549,119 @@ DA:1559,2
 DA:1561,1
 DA:1563,2
 DA:1564,1
-DA:1575,2
-DA:1576,4
-DA:1577,4
-DA:1578,2
-DA:1579,1
-DA:1580,1
+DA:1574,1
+DA:1576,2
+DA:1577,2
+DA:1578,1
+DA:1579,0
+DA:1580,0
 DA:1588,2
-DA:1589,2
-DA:1598,1
-DA:1599,2
-DA:1605,1
-DA:1609,2
-DA:1612,2
-DA:1613,4
-DA:1616,1
-DA:1617,2
-DA:1620,1
-DA:1628,1
-DA:1631,3
-DA:1632,3
-DA:1633,3
-DA:1634,3
-DA:1635,3
-DA:1636,3
+DA:1589,4
+DA:1590,4
+DA:1591,2
+DA:1592,1
+DA:1593,1
+DA:1603,1
+DA:1605,2
+DA:1611,1
+DA:1615,2
+DA:1618,2
+DA:1619,4
+DA:1622,1
+DA:1623,2
+DA:1626,1
+DA:1634,1
 DA:1637,3
 DA:1638,3
-DA:1642,1
-DA:1644,1
-DA:1645,2
-DA:1646,1
-DA:1647,2
-DA:1650,2
+DA:1639,3
+DA:1640,3
+DA:1641,3
+DA:1642,3
+DA:1643,3
+DA:1644,3
+DA:1648,1
+DA:1650,1
 DA:1651,2
-DA:1652,2
-DA:1657,1
+DA:1652,1
+DA:1653,2
+DA:1656,2
+DA:1657,2
 DA:1658,2
-DA:1659,1
 DA:1663,1
 DA:1664,2
-DA:1666,1
-DA:1667,1
-DA:1668,1
+DA:1665,1
 DA:1669,1
-DA:1670,1
-DA:1671,1
+DA:1670,2
 DA:1672,1
-DA:1674,2
-DA:1679,1
-DA:1680,3
-DA:1681,1
-DA:1683,2
+DA:1673,1
+DA:1674,1
+DA:1675,1
+DA:1676,1
+DA:1677,1
+DA:1678,1
+DA:1680,2
 DA:1685,1
-DA:1690,1
-DA:1691,2
-DA:1692,3
-DA:1693,1
-DA:1695,1
-DA:1696,2
+DA:1686,3
+DA:1687,1
+DA:1689,2
+DA:1691,1
+DA:1696,1
 DA:1697,2
-DA:1698,1
-DA:1699,2
-DA:1700,2
-DA:1701,3
-DA:1705,1
+DA:1698,3
+DA:1699,1
+DA:1701,1
+DA:1702,2
+DA:1703,2
+DA:1704,1
+DA:1705,2
 DA:1706,2
-DA:1707,4
-DA:1708,1
+DA:1707,3
+DA:1711,1
+DA:1712,2
+DA:1713,4
 DA:1714,1
-DA:1715,1
-DA:1716,2
-DA:1717,1
-DA:1719,2
 DA:1720,1
-DA:1724,2
-DA:1725,3
+DA:1721,1
+DA:1722,2
+DA:1723,1
+DA:1725,2
 DA:1726,1
-DA:1729,1
-DA:1730,1
-DA:1731,4
-DA:1733,1
-DA:1734,1
+DA:1730,2
+DA:1731,3
+DA:1732,1
 DA:1735,1
-DA:1737,1
-DA:1738,4
+DA:1736,1
+DA:1737,4
+DA:1739,1
 DA:1740,1
-DA:1744,1
-DA:1745,1
-DA:1746,4
-DA:1748,1
-DA:1749,1
+DA:1741,1
+DA:1743,1
+DA:1744,4
+DA:1746,1
+DA:1750,1
 DA:1751,1
-DA:1752,6
-DA:1753,1
+DA:1752,4
+DA:1754,1
 DA:1755,1
-DA:1758,2
+DA:1757,1
+DA:1758,6
 DA:1759,1
-DA:1761,2
-DA:1768,1
-DA:1769,3
-DA:1775,1
-DA:1776,1
-DA:1777,1
-DA:1778,1
-DA:1779,2
+DA:1761,1
+DA:1764,2
+DA:1765,1
+DA:1767,2
+DA:1774,1
+DA:1775,3
+DA:1781,1
+DA:1782,1
+DA:1783,1
 DA:1784,1
 DA:1785,2
-DA:1786,3
-LF:657
-LH:657
+DA:1790,1
+DA:1791,2
+DA:1792,3
+LF:661
+LH:659
 end_of_record
 SF:lib\src\momentum_router.dart
 DA:10,1
@@ -796,16 +800,16 @@ DA:5,3
 DA:12,1
 DA:13,2
 DA:14,2
-DA:18,1
-DA:20,1
-DA:22,3
-DA:23,2
-DA:29,1
-DA:30,3
-DA:31,5
-DA:36,1
-DA:37,2
+DA:19,1
+DA:21,1
+DA:23,3
+DA:24,2
+DA:30,1
+DA:31,3
+DA:32,5
+DA:37,1
 DA:38,2
+DA:39,2
 LF:14
 LH:14
 end_of_record

diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -28,8 +28,8 @@
     - [MomentumState](momentum-state.md "MomentumState - For event system | Momentum")
     - [MomentumService](momentum-service.md "MomentumService - Services Dependency Injection | Momentum")
     - [InjectService](inject_service.md "InjectService - Indentical Services Dependency Injection | Momentum")
-    - [Router](router.md "Router - For persistent routing | Momentum")
-    - [RouterMixin](router_mixin.md "Router - Handling route parameters | Momentum")
+    - [MomentumRouter](router.md "MomentumRouter - For persistent routing | Momentum")
+    - [RouterMixin](router_mixin.md "MomentumRouter - Handling route parameters | Momentum")
     - [MomentumTester](momentum-tester.md "MomentumTester - Testing tool | Momentum")
 
 - More

diff --git a/docs/event-system.md b/docs/event-system.md
@@ -82,7 +82,7 @@ class _LoginWidgetState extends MomentumState<LoginWidget> {
       invoke: (event) {
         switch (event.action) {
           case LoginEventAction.LoginSuccess:
-            Router.goto(context, Home);
+            MomentumRouter.goto(context, Home);
             break;
           case LoginEventAction.UsernameDoesntExists:
             showSnackbar(message: event.message);

diff --git a/docs/inject_service.md b/docs/inject_service.md
@@ -62,4 +62,4 @@ InjectService(ApiAlias.withLogs, ApiService(enableLogs: true)),
 ```
 Momentum will just basically return the one tagged with `ApiAlias.withoutLogs` because it if the first instance.
 
-!> `InjectService` is also a built in `MomentumService` like the `Router`.
+!> `InjectService` is also a built in `MomentumService` like the `MomentumRouter`.
diff --git a/docs/momentum-controller.md b/docs/momentum-controller.md
@@ -273,7 +273,7 @@ class _ExampleState extends MomentumState<ExampleWidget> {
         // "event" is of type "LoginEvent".
         if (event.success) {
           // go to home page for example.
-          Router.goto(context, Home);
+          MomentumRouter.goto(context, Home);
         } else {
           showSnackbar(message: event.message, error: true);
         }

diff --git a/docs/persistence.md b/docs/persistence.md
@@ -98,13 +98,13 @@ Momentum has a custom router system to enable persistence for the app's navigati
 - The featured example app for momentum implements this feature. See this [preview](/?id=preview).
 
 - #### Guide
-  1. You need to instantiate the built-in service called `Router` in the momentum root widget in the `services` parameter. The `Router` class has a parameter which is a list of widgets and those widgets must be a screen or page type widgets:
+  1. You need to instantiate the built-in service called `MomentumRouter` in the momentum root widget in the `services` parameter. The `MomentumRouter` class has a parameter which is a list of widgets and those widgets must be a screen or page type widgets:
   ```dart
     Momentum(
       // ...
       services: [
         // ...
-        Router([
+        MomentumRouter([
           PageA(),
           PageB(),
           PageC(),
@@ -131,13 +131,13 @@ Momentum has a custom router system to enable persistence for the app's navigati
       }
     }
   ```
-  3. Now you can navigate between pages using `Router.goto(...)` and `Router.pop(context)`:
+  3. Now you can navigate between pages using `MomentumRouter.goto(...)` and `MomentumRouter.pop(context)`:
   ```dart
     // "PageC". use type not an instance or string route name.
-    Router.goto(context, PageC);
+    MomentumRouter.goto(context, PageC);
 
     // Go back to previous page
-    Router.pop(context);
+    MomentumRouter.pop(context);
   ```
 - As you can see in the guide section above, you navigate between pages using *types* not instance or string route name. That is one of the best parts of momentum.
 
@@ -148,5 +148,5 @@ Momentum has a custom router system to enable persistence for the app's navigati
 - `persistSave` will use the `.toJson()` serialization.
 - `persistGet` will use the `.fromJson(...)` serialization.
 
-- `Router` uses both `persistSave` and `persistGet`. So if you want to use persistent navigation you need to implement those two function parameters.
-- The Persistent router saves the `indexes` of the pages. If you added a new page or reordered the items in the list inside the `Router` constructor, it is recommended to clear the data of the app to avoid errors.
+- `MomentumRouter` uses both `persistSave` and `persistGet`. So if you want to use persistent navigation you need to implement those two function parameters.
+- The Persistent router saves the `indexes` of the pages. If you added a new page or reordered the items in the list inside the `MomentumRouter` constructor, it is recommended to clear the data of the app to avoid errors.
diff --git a/docs/restart-app.md b/docs/restart-app.md
@@ -51,10 +51,10 @@ Momentum momentum() {
 Here's the two line code you're waiting for:
 
 ```dart
-await Router.resetWithContext<Home>(context);
+await MomentumRouter.resetWithContext<Home>(context);
 Momentum.restart(context, momentum());
 ```
 
-- If you are using persistent navigation, we need to call `Router.resetWithContext<Home>` to set the initial page when the app restarts.
+- If you are using persistent navigation, we need to call `MomentumRouter.resetWithContext<Home>` to set the initial page when the app restarts.
 - `Momentum.restart(...)` called the method `momentum()`.
 - Requires context so you need to call this inside a widget like a button click.