release: 3.0 (#45)

* chore: first look * chore: second pass * chore: code clean * chore: update README & CHANGELOG * chore: doc clean up
jogboms · Nov 4, 2018 · f9f9d32 · f9f9d32
1 parent 4f756b5
commit f9f9d32
Show file tree

Hide file tree

Showing 33 changed files with 748 additions and 406 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,28 @@
+# 3.0.0
+
+### Before
+
+```dart
+SpinKitFadingCircle(
+  color: Colors.white,
+  size: 50.0,
+);
+```
+
+### Now, there is an itemBuilder alternative
+
+```dart
+SpinKitFadingCircle(
+  itemBuilder: (_, int index) {
+    return DecoratedBox(
+      decoration: BoxDecoration(
+        color: index.isEven ? Colors.red : Colors.green,
+      ),
+    );
+  },
+);
+```
+
+### Which produces
+
+<img src="https://raw.githubusercontent.com/jogboms/flutter_spinkit/master/screenshots/itemBuilder.gif" width="100px">
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ A collection of loading indicators animated with flutter. Heavily inspired by [@
 
 ```yaml
 dependencies:
-  flutter_spinkit: "^2.1.0"
+  flutter_spinkit: "^3.0.0"
 ```
 
 ### ⚡️ Import
@@ -26,6 +26,24 @@ SpinKitRotatingCircle(
 );
 ```
 
+#### As from 3.0.0
+
+```dart
+SpinKitFadingCircle(
+  itemBuilder: (_, int index) {
+    return DecoratedBox(
+      decoration: BoxDecoration(
+        color: index.isEven ? Colors.red : Colors.green,
+      ),
+    );
+  },
+);
+```
+
+#### Which produces
+
+<img src="https://raw.githubusercontent.com/jogboms/flutter_spinkit/master/screenshots/itemBuilder.gif" width="100px">
+
 For more info, please, refer to the `showcase.dart` in the example.
 
 ## 🚀 Roadmap

diff --git a/analysis_options.yaml b/analysis_options.yaml
@@ -34,11 +34,11 @@ analyzer:
     # allow having TODOs in the code
     todo: ignore
   exclude:
-    - 'bin/cache/**'
+    - "bin/cache/**"
     # the following two are relative to the stocks example and the flutter package respectively
     # see https://github.com/dart-lang/sdk/issues/28463
-    - 'lib/i18n/stock_messages_*.dart'
-    - 'lib/src/http/**'
+    - "lib/i18n/stock_messages_*.dart"
+    - "lib/src/http/**"
 
 linter:
   rules:
@@ -146,6 +146,7 @@ linter:
     - unnecessary_brace_in_string_interps
     - unnecessary_getters_setters
     # - unnecessary_lambdas # https://github.com/dart-lang/linter/issues/498
+    - unnecessary_new
     - unnecessary_null_aware_assignments
     - unnecessary_null_in_if_null_operators
     - unnecessary_overrides

diff --git a/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings b/example/ios/Runner.xcworkspace/xcshareddata/WorkspaceSettings.xcsettings
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>BuildSystemType</key>
+	<string>Original</string>
+</dict>
+</plist>
diff --git a/example/lib/main.dart b/example/lib/main.dart
@@ -3,18 +3,18 @@ import 'package:flutter/material.dart';
 import './showcase.dart';
 import './workspace.dart';
 
-void main() => runApp(new App());
+void main() => runApp(App());
 
 class App extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
-    return new MaterialApp(
+    return MaterialApp(
       title: 'SpinKit Demo',
       debugShowCheckedModeBanner: false,
-      theme: new ThemeData(
+      theme: ThemeData(
         brightness: Brightness.dark,
       ),
-      home: new Scaffold(
+      home: Scaffold(
         body: SafeArea(
           child: Stack(
             children: <Widget>[

diff --git a/example/lib/showcase.dart b/example/lib/showcase.dart
@@ -4,18 +4,18 @@ import 'package:flutter_spinkit/flutter_spinkit.dart';
 class ShowCase extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
-    return new Scaffold(
+    return Scaffold(
       appBar: AppBar(
         elevation: 0.0,
         backgroundColor: Colors.transparent,
         title: Text("SpinKit", style: TextStyle(fontSize: 24.0)),
       ),
       body: SingleChildScrollView(
-        child: new Column(
+        child: Column(
           mainAxisAlignment: MainAxisAlignment.center,
           children: [
             const SizedBox(height: 32.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitRotatingCircle(color: Colors.white),
@@ -24,7 +24,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitPumpingHeart(color: Colors.white),
@@ -33,7 +33,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitWave(color: Colors.white, type: SpinKitWaveType.start),
@@ -42,7 +42,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitThreeBounce(color: Colors.white),
@@ -52,7 +52,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitCircle(color: Colors.white),
@@ -62,7 +62,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitFadingCube(color: Colors.white),
@@ -71,7 +71,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitRing(color: Colors.white),
@@ -80,7 +80,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitFadingGrid(color: Colors.white),
@@ -90,7 +90,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitSpinningCircle(color: Colors.white),
@@ -100,7 +100,7 @@ class ShowCase extends StatelessWidget {
               ],
             ),
             const SizedBox(height: 48.0),
-            new Row(
+            Row(
               mainAxisAlignment: MainAxisAlignment.spaceEvenly,
               children: [
                 SpinKitPouringHourglass(color: Colors.white),

diff --git a/example/lib/workspace.dart b/example/lib/workspace.dart
@@ -5,12 +5,18 @@ class WorkSpace extends StatelessWidget {
   @override
   Widget build(BuildContext context) {
     return Container(
-      color: Colors.orangeAccent,
+      color: Colors.white,
       width: 300.0,
       height: 300.0,
-      child: SpinKitPouringHourglass(
-        color: Colors.white,
-        size: 100.0,
+      child: SpinKitFadingCircle(
+        itemBuilder: (_, int index) {
+          return DecoratedBox(
+            decoration: BoxDecoration(
+              color: index.isEven ? Colors.red : Colors.green,
+            ),
+          );
+        },
+        size: 120.0,
       ),
     );
   }

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -75,7 +75,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.1.0"
+    version: "3.0.0"
   flutter_test:
     dependency: "direct dev"
     description: flutter

diff --git a/lib/flutter_spinkit.dart b/lib/flutter_spinkit.dart
@@ -11,6 +11,7 @@ export 'src/fading_four.dart';
 export 'src/fading_grid.dart';
 export 'src/folding_cube.dart';
 export 'src/hour_glass.dart';
+export 'src/pouring_hour_glass.dart';
 export 'src/pulse.dart';
 export 'src/pumping_heart.dart';
 export 'src/ring.dart';
@@ -21,4 +22,3 @@ export 'src/spinning_circle.dart';
 export 'src/three_bounce.dart';
 export 'src/wandering_cubes.dart';
 export 'src/wave.dart';
-export 'src/pouring_hour_glass.dart';
diff --git a/lib/src/chasing_dots.dart b/lib/src/chasing_dots.dart
@@ -3,15 +3,22 @@ import 'package:flutter/material.dart';
 class SpinKitChasingDots extends StatefulWidget {
   final Color color;
   final double size;
+  final IndexedWidgetBuilder itemBuilder;
 
-  const SpinKitChasingDots({
+  SpinKitChasingDots({
     Key key,
-    @required this.color,
+    this.color,
     this.size = 50.0,
-  }) : super(key: key);
+    this.itemBuilder,
+  })  : assert(
+            !(itemBuilder is IndexedWidgetBuilder && color is Color) &&
+                !(itemBuilder == null && color == null),
+            'You should specify either a itemBuilder or a color'),
+        assert(size != null),
+        super(key: key);
 
   @override
-  _SpinKitChasingDotsState createState() => new _SpinKitChasingDotsState();
+  _SpinKitChasingDotsState createState() => _SpinKitChasingDotsState();
 }
 
 class _SpinKitChasingDotsState extends State<SpinKitChasingDots>
@@ -23,11 +30,11 @@ class _SpinKitChasingDotsState extends State<SpinKitChasingDots>
   @override
   void initState() {
     super.initState();
-    _scaleCtrl = new AnimationController(vsync: this, duration: _duration);
-    _rotateCtrl = new AnimationController(vsync: this, duration: _duration);
+    _scaleCtrl = AnimationController(vsync: this, duration: _duration);
+    _rotateCtrl = AnimationController(vsync: this, duration: _duration);
 
     _scale = Tween(begin: -1.0, end: 1.0).animate(
-      new CurvedAnimation(parent: _scaleCtrl, curve: Curves.easeInOut),
+      CurvedAnimation(parent: _scaleCtrl, curve: Curves.easeInOut),
     )
       ..addListener(() => setState(() => <String, void>{}))
       ..addStatusListener((status) {
@@ -39,7 +46,7 @@ class _SpinKitChasingDotsState extends State<SpinKitChasingDots>
       });
 
     _rotate = Tween(begin: 0.0, end: 360.0).animate(
-      new CurvedAnimation(parent: _rotateCtrl, curve: Curves.linear),
+      CurvedAnimation(parent: _rotateCtrl, curve: Curves.linear),
     )..addListener(() => setState(() => <String, void>{}));
 
     _rotateCtrl.repeat();
@@ -64,11 +71,11 @@ class _SpinKitChasingDotsState extends State<SpinKitChasingDots>
             children: <Widget>[
               Positioned(
                 top: 0.0,
-                child: _circle(1.0 - _scale.value.abs()),
+                child: _circle(1.0 - _scale.value.abs(), 0),
               ),
               Positioned(
                 bottom: 0.0,
-                child: _circle(_scale.value.abs()),
+                child: _circle(_scale.value.abs(), 1),
               ),
             ],
           ),
@@ -77,19 +84,25 @@ class _SpinKitChasingDotsState extends State<SpinKitChasingDots>
     );
   }
 
-  Widget _circle(double scale) {
+  Widget _itemBuilder(int index) {
     final _size = widget.size * 0.6;
+    return SizedBox.fromSize(
+      size: Size.square(_size),
+      child: widget.itemBuilder != null
+          ? widget.itemBuilder(context, index)
+          : DecoratedBox(
+              decoration: BoxDecoration(
+                shape: BoxShape.circle,
+                color: widget.color,
+              ),
+            ),
+    );
+  }
 
-    return new Transform.scale(
+  Widget _circle(double scale, int index) {
+    return Transform.scale(
       scale: scale,
-      child: new Container(
-        height: _size,
-        width: _size,
-        decoration: BoxDecoration(
-          shape: BoxShape.circle,
-          color: widget.color,
-        ),
-      ),
+      child: _itemBuilder(index),
     );
   }
 }