FadeInImage.assetNetwork constructor

FadeInImage.assetNetwork({
  1. Key? key,
  2. required String placeholder,
  3. ImageErrorWidgetBuilder? placeholderErrorBuilder,
  4. required String image,
  5. ImageErrorWidgetBuilder? imageErrorBuilder,
  6. AssetBundle? bundle,
  7. double? placeholderScale,
  8. double imageScale = 1.0,
  9. bool excludeFromSemantics = false,
  10. String? imageSemanticLabel,
  11. Duration? fadeOutDuration,
  12. Curve? fadeOutCurve,
  13. Duration fadeInDuration = const Duration(milliseconds: 700),
  14. Curve fadeInCurve = Curves.easeIn,
  15. double? width,
  16. double? height,
  17. BoxFit? fit,
  18. Color? color,
  19. BlendMode? colorBlendMode,
  20. Color? placeholderColor,
  21. BlendMode? placeholderColorBlendMode,
  22. BoxFit? placeholderFit,
  23. FilterQuality filterQuality = FilterQuality.medium,
  24. FilterQuality? placeholderFilterQuality,
  25. AlignmentGeometry alignment = Alignment.center,
  26. ImageRepeat repeat = ImageRepeat.noRepeat,
  27. bool matchTextDirection = false,
  28. FadeInImageTransition transition = FadeInImageTransition.sequential,
  29. int? placeholderCacheWidth,
  30. int? placeholderCacheHeight,
  31. int? imageCacheWidth,
  32. int? imageCacheHeight,
  33. bool useLogicalCacheSize = false,
})

Creates a widget that uses a placeholder image stored in an asset bundle while loading the final image from the network.

The placeholder argument is the key of the image in the asset bundle.

The image argument is the URL of the final image.

The placeholderScale and imageScale arguments are passed to their respective ImageProviders (see also ImageInfo.scale).

If placeholderScale is omitted or is null, pixel-density-aware asset resolution will be attempted for the placeholder image. Otherwise, the exact asset specified will be used.

If placeholderCacheWidth, placeholderCacheHeight, imageCacheWidth, or imageCacheHeight are provided, it indicates to the engine that the respective image should be decoded at the specified size. The image will be rendered to the constraints of the layout or width and height regardless of these parameters. These parameters are primarily intended to reduce the memory usage of ImageCache.

If useLogicalCacheSize is true, the cache dimensions are interpreted as logical pixels instead of physical pixels. Set this to true when the cache dimensions describe the image's on-screen size in logical pixels. The flag applies to both the placeholder and the image.

The transition argument controls how the widget animates from the placeholder to the image; see FadeInImageTransition.

See also:

  • Image.asset, which has more details about loading images from asset bundles.
  • Image.network, which has more details about loading images from the network.

Implementation

FadeInImage.assetNetwork({
  super.key,
  required String placeholder,
  this.placeholderErrorBuilder,
  required String image,
  this.imageErrorBuilder,
  AssetBundle? bundle,
  double? placeholderScale,
  double imageScale = 1.0,
  this.excludeFromSemantics = false,
  this.imageSemanticLabel,
  Duration? fadeOutDuration,
  Curve? fadeOutCurve,
  this.fadeInDuration = const Duration(milliseconds: 700),
  this.fadeInCurve = Curves.easeIn,
  this.width,
  this.height,
  this.fit,
  this.color,
  this.colorBlendMode,
  this.placeholderColor,
  this.placeholderColorBlendMode,
  this.placeholderFit,
  this.filterQuality = FilterQuality.medium,
  this.placeholderFilterQuality,
  this.alignment = Alignment.center,
  this.repeat = ImageRepeat.noRepeat,
  this.matchTextDirection = false,
  this.transition = FadeInImageTransition.sequential,
  int? placeholderCacheWidth,
  int? placeholderCacheHeight,
  int? imageCacheWidth,
  int? imageCacheHeight,
  bool useLogicalCacheSize = false,
}) : assert(
       transition != FadeInImageTransition.fadeInOver ||
           (fadeOutDuration == null && fadeOutCurve == null),
       'fadeOutDuration and fadeOutCurve must be omitted or null when '
       'transition is FadeInImageTransition.fadeInOver, since the placeholder '
       'is not faded out in that mode.',
     ),
     fadeOutDuration = fadeOutDuration ?? _defaultFadeOutDuration,
     fadeOutCurve = fadeOutCurve ?? _defaultFadeOutCurve,
     placeholder = placeholderScale != null
         ? ResizeImage.resizeIfNeeded(
             placeholderCacheWidth,
             placeholderCacheHeight,
             ExactAssetImage(placeholder, bundle: bundle, scale: placeholderScale),
             useLogicalSize: useLogicalCacheSize,
           )
         : ResizeImage.resizeIfNeeded(
             placeholderCacheWidth,
             placeholderCacheHeight,
             AssetImage(placeholder, bundle: bundle),
             useLogicalSize: useLogicalCacheSize,
           ),
     image = ResizeImage.resizeIfNeeded(
       imageCacheWidth,
       imageCacheHeight,
       NetworkImage(image, scale: imageScale),
       useLogicalSize: useLogicalCacheSize,
     );