update to v 0.0.4

Author: khlebobul

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.4
+
+* Add `correctCharProbability` and `scrambleCycles` parameters
+
 ## 0.0.3
 
 * Add [Medium article](https://medium.com/@khlebobul/scramble-effect-for-text-flutter-widget-d92df44dd7a8)

README.md

@@ -16,6 +16,8 @@ TextScramble(
             text: 'Hello World!',
             speed: Duration(milliseconds: 30),
             chars: '!<>-_\\/[]{}—=+*^?#________',
+            correctCharProbability = 0.1, // Correct character probability in [0, 1]
+            scrambleCycles = 4, // Number of times to scramble the text
             style: TextStyle(
               fontSize: 40,
               color: Colors.black,

example/lib/main.dart

@@ -19,6 +19,8 @@ class MainApp extends StatelessWidget {
             text: 'Hello World!',
             speed: Duration(milliseconds: 50),
             chars: '!<>-_\\/[]{}—=+*^?#________',
+            correctCharProbability = 0.1, // Correct character probability in [0, 1]
+            scrambleCycles = 4, // Number of times to scramble the text
             style: TextStyle(
               fontSize: 40,
               color: Colors.green,

example/pubspec.yaml

@@ -9,7 +9,7 @@ environment:
 dependencies:
   flutter:
     sdk: flutter
-  use_scramble: ^0.0.1
+  use_scramble: ^0.0.4
 
 dev_dependencies:
   flutter_test:

lib/src/text_scramble.dart

@@ -7,13 +7,17 @@ class TextScramble extends StatefulWidget {
   final Duration speed;
   final String chars;
   final TextStyle? style;
+  final double correctCharProbability; // Correct character probability in [0, 1]
+  final int scrambleCycles; // Number of times to scramble the text
 
   const TextScramble({
     super.key,
     required this.text,
     this.speed = const Duration(milliseconds: 50),
     this.chars = '!<>-_\\/[]{}—=+*^?#________',
     this.style,
+    this.correctCharProbability = 0.1,
+    this.scrambleCycles = 4,
   });
 
   @override
@@ -38,7 +42,7 @@ class _TextScrambleState extends State<TextScramble> {
     int counter = 0;
     _timer = Timer.periodic(widget.speed, (timer) {
       // Check if it's time to end the animation
-      if (counter >= widget.text.length * 4) {
+      if (counter >= widget.text.length * widget.scrambleCycles) {
         timer.cancel();
         setState(() {
           _displayText = widget.text;
@@ -52,7 +56,7 @@ class _TextScrambleState extends State<TextScramble> {
           if (_done[index]) return widget.text[index];
 
           // With a 10% probability, set the correct character
-          if (_random.nextDouble() < 0.1) {
+          if (_random.nextDouble() < widget.correctCharProbability) {
             _done[index] = true;
             return widget.text[index];
           }

pubspec.yaml

@@ -1,6 +1,6 @@
 name: use_scramble
 description: "Lightweight package for random text animations inspired by useScramble"
-version: 0.0.3
+version: 0.0.4
 homepage: https://github.com/khlebobul/use_scramble
 
 environment: