adress suggested changes

Nipodemos
Commit 9878e0f49103d4c916547f9bb6a7ea7d03c40755 9878e0f4 1 parent 1a8771da
Showing 1 changed file with 219 additions and 215 deletions
README.md
--- a/README.md
View file @9878e0f
+++ b/README.md
View file @9878e0f
@@ -57,18 +57,16 @@ This is a simple project but it already makes clear how powerful Get is. As your
 - [Route Management](#route-management)
   - [How to use?](#how-to-use)
-  - [Navigating between routes](#navigating-between-routes)
-    - [SnackBars](#snackbars)
-    - [Dialogs](#dialogs)
-    - [BottomSheets](#bottomsheets)
-  - [Navigate with named routes:](#navigate-with-named-routes)
+  - [Navigation without named routes](#navigation-without-named-routes)
+  - [Navigation with named routes](#navigation-with-named-routes)
     - [Send data to named Routes:](#send-data-to-named-routes)
     - [Dynamic urls links](#dynamic-urls-links)
     - [Middleware](#middleware)
+  - [Navigation without context](#navigation-without-context)
+    - [SnackBars](#snackbars)
+    - [Dialogs](#dialogs)
+    - [BottomSheets](#bottomsheets)
   - [Nested Navigation](#nested-navigation)
-- [Syntax sugar for context-required methods](#syntax-sugar-for-context-required-methods)
-  - [Change Theme](#change-theme)
-  - [Other Advanced APIs and Manual configurations](#other-advanced-apis-and-manual-configurations)
 - [State Management](#state-management)
   - [Simple State Manager](#simple-state-manager)
     - [Advantages](#advantages)
@@ -93,9 +91,12 @@ This is a simple project but it already makes clear how powerful Get is. As your
   - [Bindings](#bindings)
     - [How to use](#how-to-use-1)
   - [SmartManagement](#smartmanagement)
+- [Utils](#utils)
+  - [Change Theme](#change-theme)
+  - [Other Advanced APIs and Manual configurations](#other-advanced-apis-and-manual-configurations)
     - [Optional Global Settings](#optional-global-settings)
-#### Want to contribute to the project? We will be proud to highlight you as one of our collaborators. Here are some points where you can contribute and make Get (and Flutter) even better.
+*Want to contribute to the project? We will be proud to highlight you as one of our collaborators. Here are some points where you can contribute and make Get (and Flutter) even better.*
 - Helping to translate the readme into other languages.
 - Adding documentation to the readme (not even half of Get's functions have been documented yet).
@@ -104,6 +105,7 @@ This is a simple project but it already makes clear how powerful Get is. As your
 - Including new functions.
 # Route Management
+
 Any contribution is welcome!
 ## How to use?
@@ -122,7 +124,7 @@ GetMaterialApp( // Before: MaterialApp(
 )
 ```
-## Navigating between routes
+## Navigation without named routes
 To navigate to a new screen:
 ```dart
@@ -194,129 +196,7 @@ Get.to(HomePage());
 ```
-### SnackBars
-
-To have a simple SnackBar with Flutter, you must get the context of Scaffold, or you must use a GlobalKey attached to your Scaffold, 
-```dart
-final snackBar = SnackBar(
-  content: Text('Hi!'),
-  action: SnackBarAction(
-    label: 'I am a old and ugly snackbar :(',
-    onPressed: (){}
-  ),
-);
-// Find the Scaffold in the widget tree and use
-// it to show a SnackBar.
-Scaffold.of(context).showSnackBar(snackBar);
-```
-
-With Get:
-
-```dart
-Get.snackbar('Hi', 'i am a modern snackbar');
-```
-
-With Get, all you have to do is call your Get.snackbar from anywhere in your code or customize it however you want!
-
-```dart
-Get.snackbar(
-  "Hey i'm a Get SnackBar!", // title
-  "It's unbelievable! I'm using SnackBar without context, without boilerplate, without Scaffold, it is something truly amazing!", // message
-  icon: Icon(Icons.alarm), 
-  shouldIconPulse: true,
-  onTap:(){},
-  barBlur: 20,
-  isDismissible: true,
-  duration: Duration(seconds: 3),
-);
-
-
-  ////////// ALL FEATURES //////////
-  //     Color colorText,
-  //     Duration duration,
-  //     SnackPosition snackPosition,
-  //     Widget titleText,
-  //     Widget messageText,
-  //     bool instantInit,
-  //     Widget icon,
-  //     bool shouldIconPulse,
-  //     double maxWidth,
-  //     EdgeInsets margin,
-  //     EdgeInsets padding,
-  //     double borderRadius,
-  //     Color borderColor,
-  //     double borderWidth,
-  //     Color backgroundColor,
-  //     Color leftBarIndicatorColor,
-  //     List<BoxShadow> boxShadows,
-  //     Gradient backgroundGradient,
-  //     FlatButton mainButton,
-  //     OnTap onTap,
-  //     bool isDismissible,
-  //     bool showProgressIndicator,
-  //     AnimationController progressIndicatorController,
-  //     Color progressIndicatorBackgroundColor,
-  //     Animation<Color> progressIndicatorValueColor,
-  //     SnackStyle snackStyle,
-  //     Curve forwardAnimationCurve,
-  //     Curve reverseAnimationCurve,
-  //     Duration animationDuration,
-  //     double barBlur,
-  //     double overlayBlur,
-  //     Color overlayColor,
-  //     Form userInputForm
-  ///////////////////////////////////
-```
-If you prefer the traditional snackbar, or want to customize it from scratch, including adding just one line (Get.snackbar makes use of a mandatory title and message), you can use 
-`Get.rawSnackbar();` which provides the RAW API on which Get.snackbar was built.
-
-### Dialogs
-
-To open dialog:
-
-```dart
-Get.dialog(YourDialogWidget());
-```
-
-To open default dialog:
-
-```dart
-Get.defaultDialog(
-  onConfirm: () => print("Ok"),
-  middleText: "Dialog made in 3 lines of code"
-);
-```
-You can also use Get.generalDialog instead of showGeneralDialog.
-
-For all other Flutter dialog widgets, including cupertinos, you can use Get.overlayContext instead of context, and open it anywhere in your code.
-For widgets that don't use Overlay, you can use Get.context.
-These two contexts will work in 99% of cases to replace the context of your UI, except for cases where inheritedWidget is used without a navigation context.
-
-### BottomSheets
-Get.bottomSheet is like showModalBottomSheet, but don't need of context.
-
-```dart
-Get.bottomSheet(
-  Container(
-    child: Wrap(
-      children: <Widget>[
-        ListTile(
-          leading: Icon(Icons.music_note),
-          title: Text('Music'),
-          onTap: () => {}
-        ),
-        ListTile(
-          leading: Icon(Icons.videocam),
-          title: Text('Video'),
-          onTap: () => {},
-        ),
-      ],
-    ),
-  );
-);
-```
-
-## Navigate with named routes:
+## Navigation with named routes
 - If you prefer to navigate by namedRoutes, Get also supports this.
 To navigate to nextScreen
@@ -528,6 +408,129 @@ class Third extends StatelessWidget {
   }
 }
 ```
+## Navigation without context
+
+### SnackBars
+
+To have a simple SnackBar with Flutter, you must get the context of Scaffold, or you must use a GlobalKey attached to your Scaffold, 
+```dart
+final snackBar = SnackBar(
+  content: Text('Hi!'),
+  action: SnackBarAction(
+    label: 'I am a old and ugly snackbar :(',
+    onPressed: (){}
+  ),
+);
+// Find the Scaffold in the widget tree and use
+// it to show a SnackBar.
+Scaffold.of(context).showSnackBar(snackBar);
+```
+
+With Get:
+
+```dart
+Get.snackbar('Hi', 'i am a modern snackbar');
+```
+
+With Get, all you have to do is call your Get.snackbar from anywhere in your code or customize it however you want!
+
+```dart
+Get.snackbar(
+  "Hey i'm a Get SnackBar!", // title
+  "It's unbelievable! I'm using SnackBar without context, without boilerplate, without Scaffold, it is something truly amazing!", // message
+  icon: Icon(Icons.alarm), 
+  shouldIconPulse: true,
+  onTap:(){},
+  barBlur: 20,
+  isDismissible: true,
+  duration: Duration(seconds: 3),
+);
+
+
+  ////////// ALL FEATURES //////////
+  //     Color colorText,
+  //     Duration duration,
+  //     SnackPosition snackPosition,
+  //     Widget titleText,
+  //     Widget messageText,
+  //     bool instantInit,
+  //     Widget icon,
+  //     bool shouldIconPulse,
+  //     double maxWidth,
+  //     EdgeInsets margin,
+  //     EdgeInsets padding,
+  //     double borderRadius,
+  //     Color borderColor,
+  //     double borderWidth,
+  //     Color backgroundColor,
+  //     Color leftBarIndicatorColor,
+  //     List<BoxShadow> boxShadows,
+  //     Gradient backgroundGradient,
+  //     FlatButton mainButton,
+  //     OnTap onTap,
+  //     bool isDismissible,
+  //     bool showProgressIndicator,
+  //     AnimationController progressIndicatorController,
+  //     Color progressIndicatorBackgroundColor,
+  //     Animation<Color> progressIndicatorValueColor,
+  //     SnackStyle snackStyle,
+  //     Curve forwardAnimationCurve,
+  //     Curve reverseAnimationCurve,
+  //     Duration animationDuration,
+  //     double barBlur,
+  //     double overlayBlur,
+  //     Color overlayColor,
+  //     Form userInputForm
+  ///////////////////////////////////
+```
+If you prefer the traditional snackbar, or want to customize it from scratch, including adding just one line (Get.snackbar makes use of a mandatory title and message), you can use 
+`Get.rawSnackbar();` which provides the RAW API on which Get.snackbar was built.
+
+### Dialogs
+
+To open dialog:
+
+```dart
+Get.dialog(YourDialogWidget());
+```
+
+To open default dialog:
+
+```dart
+Get.defaultDialog(
+  onConfirm: () => print("Ok"),
+  middleText: "Dialog made in 3 lines of code"
+);
+```
+You can also use Get.generalDialog instead of showGeneralDialog.
+
+For all other Flutter dialog widgets, including cupertinos, you can use Get.overlayContext instead of context, and open it anywhere in your code.
+For widgets that don't use Overlay, you can use Get.context.
+These two contexts will work in 99% of cases to replace the context of your UI, except for cases where inheritedWidget is used without a navigation context.
+
+### BottomSheets
+Get.bottomSheet is like showModalBottomSheet, but don't need of context.
+
+```dart
+Get.bottomSheet(
+  Container(
+    child: Wrap(
+      children: <Widget>[
+        ListTile(
+          leading: Icon(Icons.music_note),
+          title: Text('Music'),
+          onTap: () => {}
+        ),
+        ListTile(
+          leading: Icon(Icons.videocam),
+          title: Text('Video'),
+          onTap: () => {},
+        ),
+      ],
+    ),
+  );
+);
+```
 ## Nested Navigation
@@ -579,89 +582,9 @@ Navigator(
 ```
-# Syntax sugar for context-required methods
-
-## Change Theme
-Please do not use any higher level widget than GetMaterialApp in order to update it. This can trigger duplicate keys. A lot of people are used to the prehistoric approach of creating a "ThemeProvider" widget just to change the theme of your app, and this is definitely NOT necessary with Get.
-
-You can create your custom theme and simply add it within Get.changeTheme without any boilerplate for that:
-
-
-```dart
-Get.changeTheme(ThemeData.light());
-```
-
-If you want to create something like a button that changes the theme with onTap, you can combine two Get APIs for that, the api that checks if the dark theme is being used, and the theme change API, you can just put this within an onPressed:
-
-```dart
-Get.changeTheme(Get.isDarkMode? ThemeData.light(): ThemeData.dark());
-```
-
-When darkmode is activated, it will switch to the light theme, and when the light theme is activated, it will change to dark.
-
-
-If you want to know in depth how to change the theme, you can follow this tutorial on Medium that even teaches the persistence of the theme using Get:
-
-- [Dynamic Themes in 3 lines using Get](https://medium.com/swlh/flutter-dynamic-themes-in-3-lines-c3b375f292e3) - Tutorial by [Rod Brown](https://github.com/RodBr).
-
-
-
-## Other Advanced APIs and Manual configurations
-GetMaterialApp configures everything for you, but if you want to configure Get Manually using advanced APIs.
-
-```dart
-MaterialApp(
-  navigatorKey: Get.key,
-  navigatorObservers: [GetObserver()],
-);
-```
-
-You will also be able to use your own Middleware within GetObserver, this will not influence anything.
-
-```dart
-MaterialApp(
-  navigatorKey: Get.key,
-  navigatorObservers: [GetObserver(MiddleWare.observer)], // Here
-);
-```
-
-```dart
-Get.arguments // give the current args from currentScreen
-
-Get.previousArguments // give arguments of previous route
-
-Get.previousRoute // give name of previous route
-
-Get.rawRoute // give the raw route to access for example, rawRoute.isFirst()
-
-Get.routing // give access to Rounting API from GetObserver
-
-Get.isSnackbarOpen // check if snackbar is open
-
-Get.isDialogOpen // check if dialog is open
-
-Get.isBottomSheetOpen // check if bottomsheet is open
-
-Get.removeRoute() // remove one route.
-
-Get.until() // back repeatedly until the predicate returns true.
-
-Get.offUntil() // go to next route and remove all the previous routes until the predicate returns true.
-
-Get.offNamedUntil() // go to next named route and remove all the previous routes until the predicate returns true.
-
-GetPlatform.isAndroid/isIOS/isWeb... //(This method is completely compatible with FlutterWeb, unlike the framework. "Platform.isAndroid")
-
-Get.height / Get.width // Equivalent to the method: MediaQuery.of(context).size.height, but they are immutable. If you need a changeable height/width (like browser windows that can be scaled) you will need to use context.height and context.width
-
-Get.context // Gives the context of the screen in the foreground anywhere in your code.
-
-Get.contextOverlay // Gives the context of the snackbar/dialog/bottomsheet in the foreground anywhere in your code.
-
-```
-
 # State Management
-There are currently several state managers for Flutter. However, most of them involve using ChangeNotifier to update widgets and this is a bad and very bad approach to performance of medium or large applications. You can check in the official Flutter documentation that ChangeNotifier should be used with 1 or a maximum of 2 listeners (https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html), making it practically unusable for any application medium or large. 
+
+There are currently several state managers for Flutter. However, most of them involve using ChangeNotifier to update widgets and this is a bad and very bad approach to performance of medium or large applications. You can check in the official Flutter documentation that [ChangeNotifier should be used with 1 or a maximum of 2 listeners](https://api.flutter.dev/flutter/foundation/ChangeNotifier-class.html), making it practically unusable for any application medium or large.
 Other state managers are good, but have their nuances:
 - BLoC is very safe and efficient, but it is very complex for beginners, which has kept people from developing with Flutter.
@@ -1234,6 +1157,87 @@ Bindings creates transitory factories, which are created the moment you click to
 However, if you work with Services or any other abstraction, I recommend using Bindings for a larger organization.
+# Utils
+
+## Change Theme
+Please do not use any higher level widget than GetMaterialApp in order to update it. This can trigger duplicate keys. A lot of people are used to the prehistoric approach of creating a "ThemeProvider" widget just to change the theme of your app, and this is definitely NOT necessary with Get.
+
+You can create your custom theme and simply add it within Get.changeTheme without any boilerplate for that:
+
+
+```dart
+Get.changeTheme(ThemeData.light());
+```
+
+If you want to create something like a button that changes the theme with onTap, you can combine two Get APIs for that, the api that checks if the dark theme is being used, and the theme change API, you can just put this within an onPressed:
+
+```dart
+Get.changeTheme(Get.isDarkMode? ThemeData.light(): ThemeData.dark());
+```
+
+When darkmode is activated, it will switch to the light theme, and when the light theme is activated, it will change to dark.
+
+
+If you want to know in depth how to change the theme, you can follow this tutorial on Medium that even teaches the persistence of the theme using Get:
+
+- [Dynamic Themes in 3 lines using Get](https://medium.com/swlh/flutter-dynamic-themes-in-3-lines-c3b375f292e3) - Tutorial by [Rod Brown](https://github.com/RodBr).
+
+
+
+## Other Advanced APIs and Manual configurations
+GetMaterialApp configures everything for you, but if you want to configure Get Manually using advanced APIs.
+
+```dart
+MaterialApp(
+  navigatorKey: Get.key,
+  navigatorObservers: [GetObserver()],
+);
+```
+
+You will also be able to use your own Middleware within GetObserver, this will not influence anything.
+
+```dart
+MaterialApp(
+  navigatorKey: Get.key,
+  navigatorObservers: [GetObserver(MiddleWare.observer)], // Here
+);
+```
+
+```dart
+Get.arguments // give the current args from currentScreen
+
+Get.previousArguments // give arguments of previous route
+
+Get.previousRoute // give name of previous route
+
+Get.rawRoute // give the raw route to access for example, rawRoute.isFirst()
+
+Get.routing // give access to Rounting API from GetObserver
+
+Get.isSnackbarOpen // check if snackbar is open
+
+Get.isDialogOpen // check if dialog is open
+
+Get.isBottomSheetOpen // check if bottomsheet is open
+
+Get.removeRoute() // remove one route.
+
+Get.until() // back repeatedly until the predicate returns true.
+
+Get.offUntil() // go to next route and remove all the previous routes until the predicate returns true.
+
+Get.offNamedUntil() // go to next named route and remove all the previous routes until the predicate returns true.
+
+GetPlatform.isAndroid/isIOS/isWeb... //(This method is completely compatible with FlutterWeb, unlike the framework. "Platform.isAndroid")
+
+Get.height / Get.width // Equivalent to the method: MediaQuery.of(context).size.height, but they are immutable. If you need a changeable height/width (like browser windows that can be scaled) you will need to use context.height and context.width
+
+Get.context // Gives the context of the screen in the foreground anywhere in your code.
+
+Get.contextOverlay // Gives the context of the snackbar/dialog/bottomsheet in the foreground anywhere in your code.
+
+```
+
 ### Optional Global Settings
 You can create Global settings for Get. Just add Get.config to your code before pushing any route or do it directly in your GetMaterialApp