Merge branch 'release/v2.0.0'

CHANGELOG.md

@@ -1,6 +1,41 @@
+## [2.0.0] - Renaming convention
+
+### Breaking changes:
+
+#### Naming convention
+
+Since we can have different shapes for the same animation in many case, I decided to change how we call the animations.
+
+For example, the `LoadingFlipCircle()` could be called passing a `BoxShape.rectangle` as a `shape` parameter: `LoadingFlipCircle(shape: BoxShape.rectangle)`.
+
+But since it makes more sense to focus on the animation itself, the shape is now embedded on a [named constructor](https://dart.dev/guides/language/language-tour#named-constructors).
+
+Before v2.0.0:
+- circle - `LoadingFlipCircle()`
+- square - `LoadingFlipCircle(shape: BoxShape.rectangle)`
+
+After v2.0.0: 
+- circle - `LoadingFlipping.circle()`
+- square - `LoadingFlipping.square()`
+
+List of animation changes:
+- `LoadingFlipCircle()` -> `LoadingFlipping.circle()` or `.square()`
+- `LoadingRotatingSquare()` -> `LoadingRotating.square()`
+- `LoadingFlipBox()` -> `LoadingDoubleFlipping.circle()` or `.square()`
+- `LoadingBouncingGrid()` -> `LoadingBouncingGrid.circle()` or `.square()`
+
+### New animation!
+
+Added LoadingFilling.square() new animation. Please refer to the example project for more details.
+
+### Example project
+
+Files got separated from `main.dart` in order to make the examples smaller and more readable.
+
+
 ## [1.0.1] - Updating package details
 
-### Fix
+### Fix:
 - Fixing version on pubspec.yaml
 - Added full path to example images
 

README.md

@@ -1,4 +1,4 @@
-# Flutter Loading Animations
+# Flutter Loading Animations [![Pub](https://img.shields.io/pub/v/loading_animations)](https://pub.dev/packages/loading_animations)
 
 A simple yet very customizable set of loading animations for Flutter projects.
 
@@ -10,7 +10,7 @@ Add the following to your `pubspec.yaml` file:
 ...
 dependencies:
   ...
-  loading_animations: "^1.0.0"
+  loading_animations: "^2.0.0"
 ...
 ```
 
@@ -22,27 +22,35 @@ import 'package:loading_animations/loading_animations.dart';
 ## How to use
 
 Choose a loading animation from the list:
-- FlipCircle
-- RotatingSquare
-- FlipBox
-- BouncingGrid
+### LoadingFlipping
+- `LoadingFlipping.circle()`
+- `LoadingFlipping.square()`
+### LoadingRotating
+- `LoadingRotating.square()`
+### LoadingDoubleFlipping
+- `LoadingDoubleFlipping.circle()`
+- `LoadingDoubleFlipping.square()`
+### LoadingBouncingGrid
+- `LoadingBouncingGrid.circle()`
+- `LoadingBouncingGrid.square()`
+
 
 Then add the following code:
 ```dart
-LoadingFlipCircle(
+LoadingFlipping.circle(
   color: Colors.blue,
 );
 ```
 Or you can customize it a bit:
 ```dart
-LoadingFlipCircle(
+LoadingFlipping.square(
   borderColor: Colors.cyan,
   size: 30.0,
 );
 ```
 Or customize it even more!
 ```dart
-LoadingFlipCircle(
+LoadingFlipping.circle(
   borderColor: Colors.cyan,
   borderSize: 3.0,
   size: 30.0,
@@ -53,12 +61,15 @@ LoadingFlipCircle(
 
 For more customization, please look inside the loading animaton files.
 
-Note: all the animations come ready to go just by calling `LoadingFlipBox()`, for example.
+Note: all the animations come ready to go just by calling `LoadingDoubleFlipping.square()`, for example.
+
+Many basic animations contain `.circle()` and `.square()` variations by default.
 
 ## Examples
 
-For a more true experience of the animations and its variations,
-download the example project and run using `flutter run --profile`.
+Note: the following gifs are not yet updated to reflect verison 2.0.0
+
+For a more true experience of the animations and its variations, download the example project and run using `flutter run --profile`.
 
 <table>
 <tr>
@@ -70,8 +81,8 @@ LoadingRotatingSquare()
 </td>
 </tr>
 <tr>
-<td align="center"><img src="assets/LoadingFlipCircle.gif" width="200"></td>
-<td align="center"><img src="assets/LoadingRotatingSquare.gif" width="200"></td>
+<td align="center"><img src="https://github.com/cytryn/loading-animations/blob/master/assets/LoadingFlipCircle.gif?raw=true" width="300"></td>
+<td align="center"><img src="https://github.com/cytryn/loading-animations/blob/master/assets/LoadingRotatingSquare.gif?raw=true" width="300"></td>
 </tr>
 <tr>
 <td align="center">
@@ -82,8 +93,8 @@ LoadingBouncingGrid()
 </td>
 </tr>
 <tr>
-<td align="center"><img src="assets/LoadingFlipBox.gif" width="200"></td>
-<td align="center"><img src="assets/LoadingBouncingGrid.gif" width="200"></td>
+<td align="center"><img src="https://github.com/cytryn/loading-animations/blob/master/assets/LoadingFlipBox.gif?raw=true" width="300"></td>
+<td align="center"><img src="https://github.com/cytryn/loading-animations/blob/master/assets/LoadingBouncingGrid.gif?raw=true" width="300"></td>
 </tr>
 
 </table>

example/.gitignore

@@ -1,5 +1,6 @@
 # Miscellaneous
 *.class
+*.lock
 *.log
 *.pyc
 *.swp
@@ -15,10 +16,24 @@
 *.iws
 .idea/
 
-# The .vscode folder contains launch configuration and tasks you configure in
-# VS Code which you may wish to be included in version control, so this line
-# is commented out by default.
-#.vscode/
+# Visual Studio Code related
+.vscode/
+
+# Flutter repo-specific
+/bin/cache/
+/bin/mingit/
+/dev/benchmarks/mega_gallery/
+/dev/bots/.recipe_deps
+/dev/bots/android_tools/
+/dev/docs/doc/
+/dev/docs/flutter.docs.zip
+/dev/docs/lib/
+/dev/docs/pubspec.yaml
+/packages/flutter/coverage/
+version
+
+# packages file containing multi-root paths
+.packages.generated
 
 # Flutter/Dart/Pub related
 **/doc/api/
@@ -27,7 +42,11 @@
 .packages
 .pub-cache/
 .pub/
-/build/
+build/
+flutter_*.png
+linked_*.ds
+unlinked.ds
+unlinked_spec.ds
 
 # Android related
 **/android/**/gradle-wrapper.jar
@@ -37,6 +56,8 @@
 **/android/gradlew.bat
 **/android/local.properties
 **/android/**/GeneratedPluginRegistrant.java
+**/android/key.properties
+*.jks
 
 # iOS/XCode related
 **/ios/**/*.mode1v3
@@ -61,12 +82,16 @@
 **/ios/Flutter/app.flx
 **/ios/Flutter/app.zip
 **/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
 **/ios/ServiceDefinitions.json
 **/ios/Runner/GeneratedPluginRegistrant.*
 
+# Coverage
+coverage/
+
 # Exceptions to above rules.
 !**/ios/**/default.mode1v3
 !**/ios/**/default.mode2v3
 !**/ios/**/default.pbxuser
 !**/ios/**/default.perspectivev3
-!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages