feat: add repeat forever option (#72)

* add ability to repeat forever for typewriter

* feat: Add repeatForever option

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.1.0
+Add `repeatForever` option.
+
 ## 2.0.1
 * Minor updates.
 

README.md

@@ -54,7 +54,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yaml
 dependencies:
-  animated_text_kit: ^2.0.1
+  animated_text_kit: ^2.1.0
 ```
 
 ### 2. Install it
@@ -84,11 +84,12 @@ import 'package:animated_text_kit/animated_text_kit.dart';
 
 # Usage  
 
-  You can override the `duration` of animation of single text by setting its duration in each AnimatedTextKit class, also you can set the time of the pause between texts by setting the `pause` parameter and with this when `isRepeatingAnimation` is set to true, you can set number of times the animation should repeat with `totalRepeatCount`. The `speed` parameter is also included for some classes which sets the delay between the apparition of each characters. Also, the `displayFullTextOnTap` and `stopPauseOnTap` parameters have been included for some classes.
+  You can override the `duration` of animation of single text by setting its duration in each AnimatedTextKit class, also you can set the time of the pause between texts by setting the `pause` parameter and with this when `isRepeatingAnimation` is set to true, you can set number of times the animation should repeat with `totalRepeatCount` (or repeat forever with `repeatForever`). The `speed` parameter is also included for some classes which sets the delay between the apparition of each characters. Also, the `displayFullTextOnTap` and `stopPauseOnTap` parameters have been included for some classes.
 ```dart
 TypewriterAnimatedTextKit(
   duration: Duration(milliseconds: 2000),
   totalRepeatCount: 4,
+  repeatForever: true, //this will ignore [totalRepeatCount]
   pause: Duration(milliseconds:  1000),
   text: ["do IT!", "do it RIGHT!!", "do it RIGHT NOW!!!"],
   textStyle: TextStyle(fontSize: 32.0, fontWeight: FontWeight.bold),

lib/src/colorize.dart

@@ -51,6 +51,12 @@ class ColorizeAnimatedTextKit extends StatefulWidget {
   /// By default it is set to true.
   final bool isRepeatingAnimation;
 
+  /// Sets if the animation should repeat forever. [isRepeatingAnimation] also
+  /// needs to be set to true if you want to repeat forever.
+  ///
+  /// By default it is set to false, if set to true, [totalRepeatCount] is ignored.
+  final bool repeatForever;
+
   /// Sets the number of times animation should repeat
   ///
   /// By default it is set to 3
@@ -75,6 +81,7 @@ class ColorizeAnimatedTextKit extends StatefulWidget {
       this.alignment = AlignmentDirectional.topStart,
       this.textAlign = TextAlign.start,
       this.totalRepeatCount = 3,
+      this.repeatForever = false,
       this.isRepeatingAnimation = true})
       : super(key: key);
 
@@ -183,9 +190,12 @@ class _RotatingTextState extends State<ColorizeAnimatedTextKit>
 
     if (isLast) {
       if (widget.isRepeatingAnimation &&
-          (_currentRepeatCount != (widget.totalRepeatCount - 1))) {
+          (widget.repeatForever ||
+              _currentRepeatCount != (widget.totalRepeatCount - 1))) {
         _index = 0;
-        _currentRepeatCount++;
+        if (!widget.repeatForever) {
+          _currentRepeatCount++;
+        }
       } else {
         if (widget.onFinished != null) widget.onFinished();
         return;

lib/src/fade.dart

@@ -54,6 +54,12 @@ class FadeAnimatedTextKit extends StatefulWidget {
   /// By default it is set to 3
   final int totalRepeatCount;
 
+  /// Sets if the animation should repeat forever. [isRepeatingAnimation] also
+  /// needs to be set to true if you want to repeat forever.
+  ///
+  /// By default it is set to false, if set to true, [totalRepeatCount] is ignored.
+  final bool repeatForever;
+
   /// Set if the animation should not repeat by changing the value of it to false.
   ///
   /// By default it is set to true.
@@ -84,6 +90,7 @@ class FadeAnimatedTextKit extends StatefulWidget {
       this.totalRepeatCount = 3,
       this.alignment = AlignmentDirectional.topStart,
       this.textAlign = TextAlign.start,
+      this.repeatForever = false,
       this.isRepeatingAnimation = true})
       : super(key: key);
 
@@ -193,9 +200,12 @@ class _RotatingTextState extends State<FadeAnimatedTextKit>
 
     if (isLast) {
       if (widget.isRepeatingAnimation &&
-          (_currentRepeatCount != (widget.totalRepeatCount - 1))) {
+          (widget.repeatForever ||
+              _currentRepeatCount != (widget.totalRepeatCount - 1))) {
         _index = 0;
-        _currentRepeatCount++;
+        if (!widget.repeatForever) {
+          _currentRepeatCount++;
+        }
       } else {
         if (widget.onFinished != null) widget.onFinished();
         return;

lib/src/rotate.dart

@@ -58,6 +58,12 @@ class RotateAnimatedTextKit extends StatefulWidget {
   /// By default it is set to 3
   final int totalRepeatCount;
 
+  /// Sets if the animation should repeat forever. [isRepeatingAnimation] also
+  /// needs to be set to true if you want to repeat forever.
+  ///
+  /// By default it is set to false, if set to true, [totalRepeatCount] is ignored.
+  final bool repeatForever;
+
   /// Set if the animation should not repeat by changing the value of it to false.
   ///
   /// By default it is set to true.
@@ -83,6 +89,7 @@ class RotateAnimatedTextKit extends StatefulWidget {
       this.alignment = const Alignment(0.0, 0.0),
       this.textAlign = TextAlign.start,
       this.displayFullTextOnTap = false,
+      this.repeatForever = false,
       this.isRepeatingAnimation = true})
       : super(key: key);
 
@@ -201,9 +208,12 @@ class _RotatingTextState extends State<RotateAnimatedTextKit>
 
     if (isLast) {
       if (widget.isRepeatingAnimation &&
-          (_currentRepeatCount != (widget.totalRepeatCount - 1))) {
+          (widget.repeatForever ||
+              _currentRepeatCount != (widget.totalRepeatCount - 1))) {
         _index = 0;
-        _currentRepeatCount++;
+        if (!widget.repeatForever) {
+          _currentRepeatCount++;
+        }
       } else {
         if (widget.onFinished != null) widget.onFinished();
         return;

lib/src/scale.dart

@@ -54,6 +54,12 @@ class ScaleAnimatedTextKit extends StatefulWidget {
   /// By default it is set to 3
   final int totalRepeatCount;
 
+  /// Sets if the animation should repeat forever. [isRepeatingAnimation] also
+  /// needs to be set to true if you want to repeat forever.
+  ///
+  /// By default it is set to false, if set to true, [totalRepeatCount] is ignored.
+  final bool repeatForever;
+
   /// Set if the animation should not repeat by changing the value of it to false.
   ///
   /// By default it is set to true.
@@ -88,6 +94,7 @@ class ScaleAnimatedTextKit extends StatefulWidget {
       this.totalRepeatCount = 3,
       this.alignment = AlignmentDirectional.topStart,
       this.textAlign = TextAlign.start,
+      this.repeatForever = false,
       this.isRepeatingAnimation = true,
       this.displayFullTextOnTap = false,
       this.stopPauseOnTap = false})
@@ -204,9 +211,12 @@ class _RotatingTextState extends State<ScaleAnimatedTextKit>
 
     if (isLast) {
       if (widget.isRepeatingAnimation &&
-          (_currentRepeatCount != (widget.totalRepeatCount - 1))) {
+          (widget.repeatForever ||
+              _currentRepeatCount != (widget.totalRepeatCount - 1))) {
         _index = 0;
-        _currentRepeatCount++;
+        if (!widget.repeatForever) {
+          _currentRepeatCount++;
+        }
       } else {
         if (widget.onFinished != null) widget.onFinished();
         return;

lib/src/typewriter.dart

@@ -52,6 +52,12 @@ class TypewriterAnimatedTextKit extends StatefulWidget {
   /// By default it is set to 3
   final int totalRepeatCount;
 
+  /// Sets if the animation should repeat forever. [isRepeatingAnimation] also
+  /// needs to be set to true if you want to repeat forever.
+  ///
+  /// By default it is set to false, if set to true, [totalRepeatCount] is ignored.
+  final bool repeatForever;
+
   /// Set if the animation should not repeat by changing the value of it to false.
   ///
   /// By default it is set to true.
@@ -82,6 +88,7 @@ class TypewriterAnimatedTextKit extends StatefulWidget {
       this.totalRepeatCount = 3,
       this.alignment = AlignmentDirectional.topStart,
       this.textAlign = TextAlign.start,
+      this.repeatForever = false,
       this.isRepeatingAnimation = true})
       : assert(!(text == null), 'You should specify the list of text'),
         super(key: key);
@@ -208,9 +215,12 @@ class _TypewriterState extends State<TypewriterAnimatedTextKit>
 
     if (isLast) {
       if (widget.isRepeatingAnimation &&
-          (_currentRepeatCount != (widget.totalRepeatCount - 1))) {
+          (widget.repeatForever ||
+              _currentRepeatCount != (widget.totalRepeatCount - 1))) {
         _index = 0;
-        _currentRepeatCount++;
+        if (!widget.repeatForever) {
+          _currentRepeatCount++;
+        }
       } else {
         if (widget.onFinished != null) widget.onFinished();
         return;