Skip to content

Add ability to freeze animated images (GIFs) at first frame #747

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

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

Add ability to freeze animated images (GIFs) at first frame #747

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
15 changes: 15 additions & 0 deletions lib/src/extended_image.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class ExtendedImage extends StatefulWidget {
this.isAntiAlias = false,
this.handleLoadingProgress = false,
this.layoutInsets = EdgeInsets.zero,
this.animate = true,
}) : assert(constraints == null || constraints.debugAssertIsValid()),
constraints =
(width != null || height != null)
Expand Down Expand Up @@ -238,6 +239,7 @@ class ExtendedImage extends StatefulWidget {
bool cacheRawData = false,
String? imageCacheName,
this.layoutInsets = EdgeInsets.zero,
this.animate = true,
}) : assert(cacheWidth == null || cacheWidth > 0),
assert(cacheHeight == null || cacheHeight > 0),
image = ExtendedResizeImage.resizeIfNeeded(
Expand Down Expand Up @@ -336,6 +338,7 @@ class ExtendedImage extends StatefulWidget {
bool cacheRawData = false,
String? imageCacheName,
this.layoutInsets = EdgeInsets.zero,
this.animate = true,
}) : // FileImage is not supported on Flutter Web therefore neither this method.
assert(
!kIsWeb,
Expand Down Expand Up @@ -426,6 +429,7 @@ class ExtendedImage extends StatefulWidget {
bool cacheRawData = false,
String? imageCacheName,
this.layoutInsets = EdgeInsets.zero,
this.animate = true,
}) : assert(cacheWidth == null || cacheWidth > 0),
assert(cacheHeight == null || cacheHeight > 0),
image = ExtendedResizeImage.resizeIfNeeded(
Expand Down Expand Up @@ -505,6 +509,7 @@ class ExtendedImage extends StatefulWidget {
String? imageCacheName,
Duration? cacheMaxAge,
this.layoutInsets = EdgeInsets.zero,
this.animate = true,
WebHtmlElementStrategy webHtmlElementStrategy =
WebHtmlElementStrategy.never,
}) : assert(cacheWidth == null || cacheWidth > 0),
Expand Down Expand Up @@ -818,6 +823,11 @@ class ExtendedImage extends StatefulWidget {
/// Anti-aliasing alleviates the sawtooth artifact when the image is rotated.
final bool isAntiAlias;

/// Whether to enable animation for animated images (like GIFs).
/// When set to false, only the first frame will be displayed.
/// Default is true.
final bool animate;

/// Insets to apply before laying out the image.
///
/// The image will still be painted in the full area.
Expand Down Expand Up @@ -1250,6 +1260,11 @@ class _ExtendedImageState extends State<ExtendedImage>
}

void _handleImageFrame(ImageInfo imageInfo, bool synchronousCall) {
// If animation is disabled and we already have the first frame, ignore subsequent frames
if (!widget.animate && _frameNumber != null && _frameNumber! >= 0) {
return;
}

setState(() {
_replaceImage(info: imageInfo);
_loadState = LoadState.completed;
Expand Down