Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

glowRepeatCount variable added to repeat animation a specific number of times #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

glowRepeatCount variable added to repeat animation a specific number of times #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ AvatarGlow(
glowShape: BoxShape.circle,
animate: _animate,
curve: Curves.fastOutSlowIn,
glowRepeatCount: 5 // Animation will be repeated 5 times
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I would keep it the same as the other parameters. Either comment on all of them or leave out the comment

child: const Material(
elevation: 8.0,
shape: CircleBorder(),
Expand Down
1 change: 1 addition & 0 deletions example/lib/main.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ class _HomePageState extends State<HomePage> {
const SizedBox(height: 32.0),
AvatarGlow(
animate: _animate,
glowRepeatCount: 5,
glowColor: Colors.cyan,
child: Material(
elevation: 8.0,
Expand Down
29 changes: 21 additions & 8 deletions lib/src/avatar_glow.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ class AvatarGlow extends StatefulWidget {
this.repeat = true,
this.curve = Curves.fastOutSlowIn,
this.glowRadiusFactor = 0.7,
this.glowRepeatCount = -1
}) : assert(
glowShape != BoxShape.circle || glowBorderRadius == null,
'Cannot specify a border radius if the shape is a circle.',
Expand Down Expand Up @@ -58,6 +59,9 @@ class AvatarGlow extends StatefulWidget {
/// The factor that determines the size of each glow effect relative to the original size.
final double glowRadiusFactor;

/// Number of times glowing animation should be repeated
final int glowRepeatCount;

@override
State<AvatarGlow> createState() => _AvatarGlowState();
}
Expand All @@ -76,14 +80,27 @@ class _AvatarGlowState extends State<AvatarGlow>

// Check if the widget is still mounted before starting the animation.
if (mounted) {
if (widget.repeat) {
_controller.repeat();
if (widget.glowRepeatCount > 0) {
Comment on lines 82 to +83
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For reasons of readability, I would write this in a single If branch

if (mounted && widget.glowRepeatCount > 0)

TickerFuture tickerFuture = _controller.repeat();
tickerFuture.timeout(widget.duration * widget.glowRepeatCount,
onTimeout: () {
_controller.forward(from: 0);
_controller.stop(canceled: true);
});
} else {
_controller.forward();
_manageController();
}
}
}

void _manageController() {
if (widget.repeat) {
_controller.repeat();
} else {
_controller.forward();
}
}

void _stopAnimation() {
// Wait for the animation to finish before stopping it.
_controller.reverse().then((_) {
Expand Down Expand Up @@ -125,11 +142,7 @@ class _AvatarGlowState extends State<AvatarGlow>
}

if (widget.repeat != oldWidget.repeat) {
if (widget.repeat) {
_controller.repeat();
} else {
_controller.forward();
}
_manageController();
}
}

Expand Down