Cached Network Image

https://pub.dev/documentation/cached_network_image/latest
Admin
Cached Network Image is a Flutter library that loads and caches network images with support for...
Tokens:14,994
Snippets:149
Trust Score:9.9
Update:7 hours ago
Show doc for...
Tokens:
Raw
### DownloadProgress.originalUrl property

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/DownloadProgress-class.html

Gets the URL from which the file is coming.

```APIDOC
## DownloadProgress.originalUrl property

### Description
Gets the URL from which the file is coming.

### Property
`String originalUrl`

### Return Value
- **String** - Url from which the file is coming.

### Example
```dart
final url = downloadProgress.originalUrl;
```
```

--------------------------------

### DownloadProgress.totalSize property

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/DownloadProgress-class.html

Gets the final size of the download. If total size is unknown this will be null.

```APIDOC
## DownloadProgress.totalSize property

### Description
Gets the final size of the download. If total size is unknown this will be null.

### Property
`int? totalSize`

### Return Value
- **int?** - Final size of the download, or null if unknown.

### Example
```dart
final totalSize = downloadProgress.totalSize;
```
```

--------------------------------

### DownloadProgress.downloaded property

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/DownloadProgress-class.html

Gets the total of currently downloaded bytes.

```APIDOC
## DownloadProgress.downloaded property

### Description
Gets the total of currently downloaded bytes.

### Property
`int downloaded`

### Return Value
- **int** - Total of currently downloaded bytes.

### Example
```dart
final downloaded = downloadProgress.downloaded;
```
```

--------------------------------

### DownloadProgress.progress property

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/DownloadProgress-class.html

Gets the download progress as a double between 0 and 1. Returns null when the final size is unknown or the downloaded size exceeds the total size.

```APIDOC
## DownloadProgress.progress property

### Description
Gets the download progress as a double between 0 and 1. Returns null when the final size is unknown or the downloaded size exceeds the total size.

### Property
`double? progress`

### Return Value
- **double?** - The download progress as a value between 0 and 1, or null if the total size is unknown or downloaded exceeds total size.

### Example
```dart
final progress = downloadProgress.progress;
```
```

--------------------------------

### LoadingErrorWidgetBuilder typedef

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/LoadingErrorWidgetBuilder.html

Builder function to create an error widget. This builder is called when the image failed loading, for example due to a 404 NotFound exception.

```APIDOC
## LoadingErrorWidgetBuilder typedef

### Description
Builder function to create an error widget. This builder is called when the image failed loading, for example due to a 404 NotFound exception.

### Signature
```dart
typedef LoadingErrorWidgetBuilder =
    Widget Function(BuildContext context, String url, Object error);
```

### Parameters
- **context** (BuildContext) - The build context.
- **url** (String) - The URL of the image that failed to load.
- **error** (Object) - The error that occurred during loading.

### Returns
- **Widget** - The error widget to display.
```

--------------------------------

### CachedNetworkImage with imageBuilder for custom decoration

Source: https://pub.dev/documentation/cached_network_image/latest/index.html

Use imageBuilder to customize the display of the loaded image, for example by wrapping it in a Container with a BoxDecoration. This allows combining placeholder and image provider functionality.

```dart
CachedNetworkImage(
  imageUrl: "http://via.placeholder.com/200x150",
  imageBuilder: (context, imageProvider) => Container(
    decoration: BoxDecoration(
      image: DecorationImage(
          image: imageProvider,
          fit: BoxFit.cover,
          colorFilter:
              ColorFilter.mode(Colors.red, BlendMode.colorBurn)),
    ),
  ),
  placeholder: (context, url) => CircularProgressIndicator(),
  errorWidget: (context, url, error) => Icon(Icons.error),
),
```

--------------------------------

### static CacheManagerLogLevel logLevel

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImage-class.html

Gets or sets the current log level of the cache manager.

```APIDOC
## [STATIC PROPERTY] logLevel

### Description
Get the current log level of the cache manager.

### Type
`CacheManagerLogLevel`

### Access
Getter/setter pair
```

--------------------------------

### CachedNetworkImageProvider.defaultCacheManager

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Static property that gets or sets the default cache manager used for image caching.

```APIDOC
## CachedNetworkImageProvider.defaultCacheManager

### Description
Gets or sets the default cache manager used for image caching.

### Property
`static BaseCacheManager defaultCacheManager`

### Type
BaseCacheManager

### Access
Getter/Setter pair

### Remarks
This is a static property of the CachedNetworkImageProvider class.
```

--------------------------------

### DownloadProgress constructor

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/DownloadProgress-class.html

Creates a DownloadProgress instance with the given originalUrl, totalSize, and downloaded bytes.

```APIDOC
## DownloadProgress constructor

### Description
Creates a DownloadProgress instance with the given originalUrl, totalSize, and downloaded bytes.

### Constructor
DownloadProgress(String originalUrl, int? totalSize, int downloaded)

### Parameters
- **originalUrl** (String) - Required - Url from which the file is coming.
- **totalSize** (int?) - Required - Final size of the download. If total size is unknown this will be null.
- **downloaded** (int) - Required - Total of currently downloaded bytes.

### Example
```dart
DownloadProgress progress = DownloadProgress('https://example.com/file.png', 1000, 250);
```
```

--------------------------------

### obtainKey

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Converts an ImageProvider's settings plus an ImageConfiguration to a key that describes the precise image to load. This method overrides the base implementation.

```APIDOC
## obtainKey

### Description
Converts an [ImageProvider](https://api.flutter.dev/flutter/painting/ImageProvider-class.html)'s settings plus an [ImageConfiguration](https://api.flutter.dev/flutter/painting/ImageConfiguration-class.html) to a key that describes the precise image to load.

### Method
obtainKey

### Signature
`obtainKey(ImageConfiguration configuration) → Future<CachedNetworkImageProvider>`

### Parameters
- **configuration** (ImageConfiguration) - Required - The configuration for the image.

### Returns
[Future](https://api.flutter.dev/flutter/dart-async/Future-class.html)<[CachedNetworkImageProvider](https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html)> - A future that resolves to the key.
```

--------------------------------

### loadBuffer

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Converts a key into an ImageStreamCompleter and begins fetching the image. This method overrides the base implementation.

```APIDOC
## loadBuffer

### Description
Converts a key into an [ImageStreamCompleter](https://api.flutter.dev/flutter/painting/ImageStreamCompleter-class.html), and begins fetching the image.

### Method
loadBuffer

### Signature
`loadBuffer(CachedNetworkImageProvider key, DecoderBufferCallback decode) → ImageStreamCompleter`

### Parameters
- **key** (CachedNetworkImageProvider) - Required - The key for the image to load.
- **decode** (DecoderBufferCallback) - Required - The callback to decode the image buffer.

### Returns
[ImageStreamCompleter](https://api.flutter.dev/flutter/painting/ImageStreamCompleter-class.html) - The stream completer for the image.
```

--------------------------------

### loadImage

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Converts a key into an ImageStreamCompleter and begins fetching the image. This method overrides the base implementation.

```APIDOC
## loadImage

### Description
Converts a key into an [ImageStreamCompleter](https://api.flutter.dev/flutter/painting/ImageStreamCompleter-class.html), and begins fetching the image.

### Method
loadImage

### Signature
`loadImage(CachedNetworkImageProvider key, ImageDecoderCallback decode) → ImageStreamCompleter`

### Parameters
- **key** (CachedNetworkImageProvider) - Required - The key for the image to load.
- **decode** (ImageDecoderCallback) - Required - The callback to decode the image.

### Returns
[ImageStreamCompleter](https://api.flutter.dev/flutter/painting/ImageStreamCompleter-class.html) - The stream completer for the image.
```

--------------------------------

### CachedNetworkImageProvider constructor

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Creates an ImageProvider which loads an image from the url, using the scale. When the image fails to load errorListener is called.

```APIDOC
## CachedNetworkImageProvider constructor

### Description
Creates an ImageProvider which loads an image from the `url`, using the `scale`. When the image fails to load `errorListener` is called.

### Constructor
`CachedNetworkImageProvider(String url, {int? maxHeight, int? maxWidth, double scale = 1.0, ErrorListener? errorListener, Map<String, String>? headers, BaseCacheManager? cacheManager, String? cacheKey, ImageRenderMethodForWeb imageRenderMethodForWeb = ImageRenderMethodForWeb.HtmlImage})`

### Parameters
- **url** (String) - Required - The URL of the image to load.
- **maxHeight** (int?) - Optional - The maximum height of the image.
- **maxWidth** (int?) - Optional - The maximum width of the image.
- **scale** (double) - Optional - The scale of the image. Defaults to 1.0.
- **errorListener** (ErrorListener?) - Optional - A callback that is called when the image fails to load.
- **headers** (Map<String, String>?) - Optional - HTTP headers to include in the image request.
- **cacheManager** (BaseCacheManager?) - Optional - A custom cache manager to use for caching.
- **cacheKey** (String?) - Optional - A custom cache key for the image.
- **imageRenderMethodForWeb** (ImageRenderMethodForWeb) - Optional - The rendering method for web. Defaults to ImageRenderMethodForWeb.HtmlImage.

### Usage Example
```dart
CachedNetworkImageProvider(
  'https://example.com/image.png',
  maxHeight: 100,
  maxWidth: 100,
  scale: 1.0,
  errorListener: (error) { print('Failed to load image: $error'); },
  headers: {'Authorization': 'Bearer token'},
  cacheManager: myCacheManager,
  cacheKey: 'unique-key',
  imageRenderMethodForWeb: ImageRenderMethodForWeb.HtmlImage,
)
```
```

--------------------------------

### MultiImageStreamCompleter constructor

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/MultiImageStreamCompleter-class.html

Creates a MultiImageStreamCompleter with a stream of codecs and optional chunk events.

```APIDOC
## MultiImageStreamCompleter({required Stream<Codec> codec, required double scale, String? debugLabel, Stream<ImageChunkEvent>? chunkEvents, InformationCollector? informationCollector})

### Description
Creates a MultiImageStreamCompleter. The `codec` is a stream of images to display, and `chunkEvents` provides progress events for the first image.

### Parameters
- **codec** (Stream<Codec>) - Required - A stream of codecs representing the images to show.
- **scale** (double) - Required - The scale factor for the images.
- **debugLabel** (String?) - Optional - A label for debugging.
- **chunkEvents** (Stream<ImageChunkEvent>?) - Optional - Events indicating the loading progress of the first image.
- **informationCollector** (InformationCollector?) - Optional - Collects additional information for error reporting.

### Example
```dart
MultiImageStreamCompleter(
  codec: myCodecStream,
  scale: 1.0,
  debugLabel: 'myImage',
  chunkEvents: myChunkEvents,
  informationCollector: () => <DiagnosticsNode>[],
);
```
```

--------------------------------

### static Future<bool> evictFromCache(String url, {String? cacheKey, BaseCacheManager? cacheManager, double scale = 1})

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImage-class.html

Evicts an image from both the disk file based caching system of the BaseCacheManager and the in-memory ImageCache of the ImageProvider. The url is used by both the disk and memory cache, and the scale is only used to clear the image from the ImageCache.

```APIDOC
## [STATIC METHOD] evictFromCache

### Description
Evict an image from both the disk file based caching system of the `BaseCacheManager` as the in memory `ImageCache` of the `ImageProvider`. `url` is used by both the disk and memory cache. The scale is only used to clear the image from the `ImageCache`.

### Method
STATIC METHOD

### Signature
`static Future<bool> evictFromCache(String url, {String? cacheKey, BaseCacheManager? cacheManager, double scale = 1})`

### Parameters
- **url** (String) - Required - The URL of the image to evict.
- **cacheKey** (String?) - Optional - A custom cache key.
- **cacheManager** (BaseCacheManager?) - Optional - A custom cache manager.
- **scale** (double) - Optional - The scale used to clear the image from the ImageCache. Defaults to 1.

### Returns
- **Future<bool>** - A future that resolves to a boolean indicating whether the eviction was successful.
```

--------------------------------

### PlaceholderWidgetBuilder typedef

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/PlaceholderWidgetBuilder.html

Builder function to create a placeholder widget. The function is called once while the ImageProvider is loading the image.

```APIDOC
## PlaceholderWidgetBuilder typedef

### Description
Builder function to create a placeholder widget. The function is called once while the ImageProvider is loading the image.

### Signature
```dart
typedef PlaceholderWidgetBuilder =
    Widget Function(BuildContext context, String url);
```

### Parameters
- **context** (BuildContext) - The build context.
- **url** (String) - The URL of the image being loaded.

### Returns
- **Widget** - The placeholder widget to display while the image is loading.
```

--------------------------------

### CachedNetworkImage constructor

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImage-class.html

Creates a CachedNetworkImage widget that displays a network image with caching, placeholder, error, and fade-in/out support. It accepts various parameters to customize the image display, caching behavior, and loading states.

```APIDOC
## CachedNetworkImage constructor

### Description
Creates a CachedNetworkImage widget that displays a network image with caching, placeholder, error, and fade-in/out support. It accepts various parameters to customize the image display, caching behavior, and loading states.

### Constructor
CachedNetworkImage({
  Key? key,
  required String imageUrl,
  Map<String, String>? httpHeaders,
  ImageWidgetBuilder? imageBuilder,
  PlaceholderWidgetBuilder? placeholder,
  ProgressIndicatorBuilder? progressIndicatorBuilder,
  LoadingErrorWidgetBuilder? errorWidget,
  Duration? fadeOutDuration = const Duration(milliseconds: 1000),
  Curve fadeOutCurve = Curves.easeOut,
  Duration fadeInDuration = const Duration(milliseconds: 500),
  Curve fadeInCurve = Curves.easeIn,
  double? width,
  double? height,
  BoxFit? fit,
  Alignment alignment = Alignment.center,
  ImageRepeat repeat = ImageRepeat.noRepeat,
  bool matchTextDirection = false,
  BaseCacheManager? cacheManager,
  bool useOldImageOnUrlChange = false,
  Color? color,
  FilterQuality filterQuality = FilterQuality.low,
  BlendMode? colorBlendMode,
  Duration? placeholderFadeInDuration,
  int? memCacheWidth,
  int? memCacheHeight,
  String? cacheKey,
  int? maxWidthDiskCache,
  int? maxHeightDiskCache,
  ValueChanged<Object>? errorListener,
  ImageRenderMethodForWeb imageRenderMethodForWeb = ImageRenderMethodForWeb.HtmlImage,
  double scale = 1.0,
})

### Parameters
- **key** (Key?) - Optional - The widget's key.
- **imageUrl** (String) - Required - The URL of the network image to display.
- **httpHeaders** (Map<String, String>?) - Optional - HTTP headers to send with the image request.
- **imageBuilder** (ImageWidgetBuilder?) - Optional - A builder that customizes the image widget after it is loaded.
- **placeholder** (PlaceholderWidgetBuilder?) - Optional - A widget to show while the image is loading.
- **progressIndicatorBuilder** (ProgressIndicatorBuilder?) - Optional - A builder that shows a progress indicator during loading.
- **errorWidget** (LoadingErrorWidgetBuilder?) - Optional - A widget to show when the image fails to load.
- **fadeOutDuration** (Duration?) - Optional - Duration of the fade-out animation when the image changes. Defaults to 1000 milliseconds.
- **fadeOutCurve** (Curve) - Optional - Curve for the fade-out animation. Defaults to Curves.easeOut.
- **fadeInDuration** (Duration) - Optional - Duration of the fade-in animation when the image loads. Defaults to 500 milliseconds.
- **fadeInCurve** (Curve) - Optional - Curve for the fade-in animation. Defaults to Curves.easeIn.
- **width** (double?) - Optional - The width of the image.
- **height** (double?) - Optional - The height of the image.
- **fit** (BoxFit?) - Optional - How the image should be inscribed into the box.
- **alignment** (Alignment) - Optional - How the image should be aligned within its bounds. Defaults to Alignment.center.
- **repeat** (ImageRepeat) - Optional - How the image should be repeated. Defaults to ImageRepeat.noRepeat.
- **matchTextDirection** (bool) - Optional - Whether to paint the image in the direction of the ambient Directionality. Defaults to false.
- **cacheManager** (BaseCacheManager?) - Optional - A custom cache manager to use for caching.
- **useOldImageOnUrlChange** (bool) - Optional - Whether to keep showing the old image while the new one loads when the URL changes. Defaults to false.
- **color** (Color?) - Optional - A color to blend with the image.
- **filterQuality** (FilterQuality) - Optional - The filter quality to use when scaling the image. Defaults to FilterQuality.low.
- **colorBlendMode** (BlendMode?) - Optional - The blend mode to use when blending the color with the image.
- **placeholderFadeInDuration** (Duration?) - Optional - Duration of the fade-in animation for the placeholder.
- **memCacheWidth** (int?) - Optional - The width to use for the memory cache.
- **memCacheHeight** (int?) - Optional - The height to use for the memory cache.
- **cacheKey** (String?) - Optional - A custom cache key for the image.
- **maxWidthDiskCache** (int?) - Optional - The maximum width for the disk cache.
- **maxHeightDiskCache** (int?) - Optional - The maximum height for the disk cache.
- **errorListener** (ValueChanged<Object>?) - Optional - A callback that is invoked when an error occurs.
- **imageRenderMethodForWeb** (ImageRenderMethodForWeb) - Optional - The render method to use on the web. Defaults to ImageRenderMethodForWeb.HtmlImage.
- **scale** (double) - Optional - The scale to apply to the image. Defaults to 1.0.

### Usage Example
```dart
CachedNetworkImage(
  imageUrl: 'https://example.com/image.png',
  placeholder: (context, url) => CircularProgressIndicator(),
  errorWidget: (context, url, error) => Icon(Icons.error),
)
```
```

--------------------------------

### CachedNetworkImageProvider.resolve() (inherited)

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Called by resolve with the key returned by obtainKey. This method is inherited from ImageProvider.

```APIDOC
## CachedNetworkImageProvider.resolve() (inherited)

### Description
Called by [resolve](https://api.flutter.dev/flutter/painting/ImageProvider/resolve.html) with the key returned by [obtainKey](https://api.flutter.dev/flutter/painting/ImageProvider/obtainKey.html). This method is inherited from ImageProvider.

### Method
`resolve(ImageConfiguration configuration)`

### Parameters
- **configuration** (ImageConfiguration) - The image configuration.

### Return Type
ImageStream

### Inherited From
ImageProvider
```

--------------------------------

### MultiImageStreamCompleter Methods

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/MultiImageStreamCompleter-class.html

Methods available on MultiImageStreamCompleter, including overridden and inherited methods.

```APIDOC
## MultiImageStreamCompleter Methods

### addEphemeralErrorListener

Adds an error listener callback that is called when the first error is reported.

**Signature:** `void addEphemeralErrorListener(ImageErrorListener listener)`

**Parameters:**
- `listener` (ImageErrorListener) - The error listener callback.

**Inherited from:** ImageStreamCompleter

### addListener

Adds a listener callback that is called whenever a new concrete ImageInfo object is available or an error is reported. If a concrete image is already available, or if an error has been already reported, this object will notify the listener synchronously.

**Signature:** `void addListener(ImageStreamListener listener)`

**Parameters:**
- `listener` (ImageStreamListener) - The listener callback.

**Overrides:** ImageStreamCompleter.addListener

### addOnLastListenerRemovedCallback

Adds a callback to call when removeListener results in an empty list of listeners and there are no keepAlive handles outstanding.

**Signature:** `void addOnLastListenerRemovedCallback(VoidCallback callback)`

**Parameters:**
- `callback` (VoidCallback) - The callback to call.

**Inherited from:** ImageStreamCompleter

### debugFillProperties

Accumulates a list of strings describing the object's state. Subclasses should override this to have their information included in toString.

**Signature:** `void debugFillProperties(DiagnosticPropertiesBuilder description)`

**Parameters:**
- `description` (DiagnosticPropertiesBuilder) - The builder to fill.

**Inherited from:** Diagnosticable

### keepAlive

Creates an ImageStreamCompleterHandle that will prevent this stream from being disposed at least until the handle is disposed.

**Signature:** `ImageStreamCompleterHandle keepAlive()`

**Returns:** ImageStreamCompleterHandle - A handle that keeps the stream alive.

**Overrides:** ImageStreamCompleter.keepAlive

### maybeDispose

Disposes this ImageStreamCompleter unless there are active listeners or keepAlive handles.

**Signature:** `void maybeDispose()`

**Inherited from:** ImageStreamCompleter

### noSuchMethod

Invoked when a nonexistent method or property is accessed.

**Signature:** `dynamic noSuchMethod(Invocation invocation)`

**Parameters:**
- `invocation` (Invocation) - The invocation details.

**Inherited from:** Object

### onDisposed

Called when this ImageStreamCompleter has actually been disposed.

**Signature:** `void onDisposed()`

**Inherited from:** ImageStreamCompleter

### removeListener

Stops the specified listener from receiving image stream events.

**Signature:** `void removeListener(ImageStreamListener listener)`

**Parameters:**
- `listener` (ImageStreamListener) - The listener to remove.

**Overrides:** ImageStreamCompleter.removeListener

### removeOnLastListenerRemovedCallback

Removes a callback previously supplied to addOnLastListenerRemovedCallback.

**Signature:** `void removeOnLastListenerRemovedCallback(VoidCallback callback)`

**Parameters:**
- `callback` (VoidCallback) - The callback to remove.

**Inherited from:** ImageStreamCompleter

### reportError

Calls all the registered error listeners to notify them of an error that occurred while resolving the image.

**Signature:** `void reportError({DiagnosticsNode? context, required Object exception, StackTrace? stack, InformationCollector? informationCollector, bool silent = false})`

**Parameters:**
- `context` (DiagnosticsNode?) - Optional context.
- `exception` (Object) - The exception that occurred.
- `stack` (StackTrace?) - Optional stack trace.
- `informationCollector` (InformationCollector?) - Optional information collector.
- `silent` (bool) - Whether to report silently.

**Inherited from:** ImageStreamCompleter

### reportImageChunkEvent

Reports an image chunk event.

**Signature:** `void reportImageChunkEvent(ImageChunkEvent event)`

**Parameters:**
- `event` (ImageChunkEvent) - The chunk event.

**Inherited from:** ImageStreamCompleter
```

--------------------------------

### resolveStreamForKey

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Resolves the image stream for a given key. This method is inherited from ImageProvider.

```APIDOC
## resolveStreamForKey

### Description
Resolves the image stream for a given key.

### Method
resolveStreamForKey

### Signature
`resolveStreamForKey(ImageConfiguration configuration, ImageStream stream, CachedNetworkImageProvider key, ImageErrorListener handleError) → void`

### Parameters
- **configuration** (ImageConfiguration) - Required - The configuration for the image.
- **stream** (ImageStream) - Required - The stream to resolve.
- **key** (CachedNetworkImageProvider) - Required - The key for the image.
- **handleError** (ImageErrorListener) - Required - The error handler.

### Returns
void
```

--------------------------------

### ImageWidgetBuilder typedef

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/ImageWidgetBuilder.html

Builder function to create an image widget. The function is called after the ImageProvider completes the image loading.

```APIDOC
## ImageWidgetBuilder typedef

### Description
Builder function to create an image widget. The function is called after the ImageProvider completes the image loading.

### Signature
```dart
typedef ImageWidgetBuilder =
    Widget Function(BuildContext context, ImageProvider imageProvider);
```

### Parameters
- **context** (BuildContext) - The build context.
- **imageProvider** (ImageProvider) - The image provider that has completed loading.

### Returns
- **Widget** - The image widget to display.
```

--------------------------------

### PlaceholderWidgetBuilder typedef implementation

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/PlaceholderWidgetBuilder.html

Defines the PlaceholderWidgetBuilder as a function that takes a BuildContext and a String URL, returning a Widget. It is called once while the ImageProvider is loading the image.

```dart
typedef PlaceholderWidgetBuilder =
    Widget Function(BuildContext context, String url);
```

--------------------------------

### ProgressIndicatorBuilder typedef implementation

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/ProgressIndicatorBuilder.html

The typedef signature for a builder that creates a progress indicator widget. It takes a BuildContext, the image URL, and DownloadProgress, and returns a Widget. Called on each chunk download and at least once during loading.

```dart
typedef ProgressIndicatorBuilder =
    Widget Function(
      BuildContext context,
      String url,
      DownloadProgress progress,
    );
```

--------------------------------

### CachedNetworkImageProvider.toString()

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Returns a string representation of this object. This method overrides the default implementation.

```APIDOC
## CachedNetworkImageProvider.toString()

### Description
Returns a string representation of this object. This method overrides the default implementation.

### Method
`String toString()`

### Return Type
String

### Overrides
This method overrides the default `toString` method.
```

--------------------------------

### CachedNetworkImage Properties

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImage-class.html

Lists the configurable properties of the CachedNetworkImage widget, including their types and descriptions.

```APIDOC
## CachedNetworkImage Properties

### Description
This section documents the properties of the CachedNetworkImage widget, which is used to display network images with caching. Each property allows customization of the image loading and display behavior.

### Properties

#### httpHeaders
- **Type**: Map<String, String>?
- **Description**: Optional headers for the http request of the image url.

#### imageBuilder
- **Type**: ImageWidgetBuilder?
- **Description**: Optional builder to further customize the display of the image.

#### imageUrl
- **Type**: String
- **Description**: The target image that is displayed.

#### key
- **Type**: Key?
- **Description**: Controls how one widget replaces another widget in the tree. (inherited)

#### matchTextDirection
- **Type**: bool
- **Description**: Whether to paint the image in the direction of the TextDirection.

#### maxHeightDiskCache
- **Type**: int?
- **Description**: Will resize the image and store the resized image in the disk cache.

#### maxWidthDiskCache
- **Type**: int?
- **Description**: Will resize the image and store the resized image in the disk cache.

#### memCacheHeight
- **Type**: int?
- **Description**: Will resize the image in memory to have a certain height using ResizeImage.

#### memCacheWidth
- **Type**: int?
- **Description**: Will resize the image in memory to have a certain width using ResizeImage.

#### placeholder
- **Type**: PlaceholderWidgetBuilder?
- **Description**: Widget displayed while the target imageUrl is loading.

#### placeholderFadeInDuration
- **Type**: Duration?
- **Description**: The duration of the fade-in animation for the placeholder.

#### progressIndicatorBuilder
- **Type**: ProgressIndicatorBuilder?
- **Description**: Widget displayed while the target imageUrl is loading.

#### repeat
- **Type**: ImageRepeat
- **Description**: How to paint any portions of the layout bounds not covered by the image.

#### runtimeType
- **Type**: Type
- **Description**: A representation of the runtime type of the object. (inherited, no setter)

#### useOldImageOnUrlChange
- **Type**: bool
- **Description**: When set to true it will animate from the old image to the new image if the url changes.
```

--------------------------------

### CachedNetworkImageProvider Properties

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

Configuration properties for the CachedNetworkImageProvider class, allowing customization of caching, headers, dimensions, and error handling.

```APIDOC
## CachedNetworkImageProvider Properties

### Description
These properties configure the CachedNetworkImageProvider, which loads and caches network images in Flutter.

### Properties

#### cacheKey
- **Type**: String?
- **Description**: Cache key of the image to cache.

#### cacheManager
- **Type**: BaseCacheManager?
- **Description**: CacheManager from which the image files are loaded.

#### errorListener
- **Type**: ErrorListener?
- **Description**: Listener to be called when images fails to load.

#### headers
- **Type**: Map<String, String>?
- **Description**: Set headers for the image provider, for example for authentication.

#### imageRenderMethodForWeb
- **Type**: ImageRenderMethodForWeb
- **Description**: Render option for images on the web platform.

#### maxHeight
- **Type**: int?
- **Description**: Maximum height of the loaded image. If not null and using an `ImageCacheManager` the image is resized on disk to fit the height.

#### maxWidth
- **Type**: int?
- **Description**: Maximum width of the loaded image. If not null and using an `ImageCacheManager` the image is resized on disk to fit the width.

#### scale
- **Type**: double
- **Description**: Scale of the image.

#### url
- **Type**: String
- **Description**: Web url of the image to load.
```

--------------------------------

### CachedNetworkImage with progress indicator builder

Source: https://pub.dev/documentation/cached_network_image/latest/index.html

Use CachedNetworkImage with a progressIndicatorBuilder to show download progress. The builder receives a downloadProgress object with a progress value.

```dart
CachedNetworkImage(
       imageUrl: "http://via.placeholder.com/350x150",
       progressIndicatorBuilder: (context, url, downloadProgress) => 
               CircularProgressIndicator(value: downloadProgress.progress),
       errorWidget: (context, url, error) => Icon(Icons.error),
    ),
```

--------------------------------

### LoadingErrorWidgetBuilder typedef implementation

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/LoadingErrorWidgetBuilder.html

Defines the signature for a builder that creates an error widget when an image fails to load. The function receives the BuildContext, the image URL, and the error object. This is used by cached_network_image to display a custom error widget.

```dart
typedef LoadingErrorWidgetBuilder =
    Widget Function(BuildContext context, String url, Object error);
```

--------------------------------

### ProgressIndicatorBuilder typedef

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/ProgressIndicatorBuilder.html

A typedef for a builder function that creates a progress indicator widget. The function is called every time a chunk of the image is downloaded from the web, but at least once during image loading.

```APIDOC
## ProgressIndicatorBuilder typedef

### Description
Builder function to create a progress indicator widget. The function is called every time a chunk of the image is downloaded from the web, but at least once during image loading.

### Signature
```dart
typedef ProgressIndicatorBuilder =
    Widget Function(
      BuildContext context,
      String url,
      DownloadProgress progress,
    );
```

### Parameters
- **context** (BuildContext) - The build context.
- **url** (String) - The URL of the image being loaded.
- **progress** (DownloadProgress) - The current download progress.

### Returns
- **Widget** - The progress indicator widget to display.

### Implementation
```dart
typedef ProgressIndicatorBuilder =
    Widget Function(
      BuildContext context,
      String url,
      DownloadProgress progress,
    );
```
```

--------------------------------

### CachedNetworkImage with placeholder and error widget

Source: https://pub.dev/documentation/cached_network_image/latest/index.html

Use CachedNetworkImage with a placeholder widget shown while loading and an error widget on failure. The imageUrl points to a placeholder image service.

```dart
CachedNetworkImage(
        imageUrl: "http://via.placeholder.com/350x150",
        placeholder: (context, url) => CircularProgressIndicator(),
        errorWidget: (context, url, error) => Icon(Icons.error),
     ),
```

--------------------------------

### CachedNetworkImageProvider.operator ==

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CachedNetworkImageProvider-class.html

The equality operator. Determines whether this object is equal to another object.

```APIDOC
## CachedNetworkImageProvider.operator ==

### Description
The equality operator. Determines whether this object is equal to another object.

### Method
`bool operator ==(Object other)`

### Parameters
- **other** (Object) - The object to compare with this instance.

### Return Type
bool

### Overrides
This method overrides the default equality operator.
```

--------------------------------

### ImageWidgetBuilder typedef implementation

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/ImageWidgetBuilder.html

Defines the ImageWidgetBuilder typedef as a function that takes a BuildContext and an ImageProvider and returns a Widget. Used to customize the widget created after image loading completes.

```dart
typedef ImageWidgetBuilder =
    Widget Function(BuildContext context, ImageProvider imageProvider);
```

--------------------------------

### CacheManagerLogLevel enum

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/CacheManagerLogLevel.html

Enum defining log levels for the cache manager. Values: none, warning, debug, verbose. Debug shows failed downloads; verbose also shows successful downloads and cache retrievals.

```APIDOC
## CacheManagerLogLevel enum

### Description
Log levels of the cache manager. Debug shows failed downloads and verbose also shows successful downloads and cache retrievals.

### Values
- **none** - const CacheManagerLogLevel
- **warning** - const CacheManagerLogLevel
- **debug** - const CacheManagerLogLevel
- **verbose** - const CacheManagerLogLevel

### Properties
- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by EnumName extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- **noSuchMethod** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString** (String) - A string representation of this object. (inherited)

### Operators
- **operator ==** (bool) - The equality operator. (inherited)

### Constants
- **values** (List<CacheManagerLogLevel>) - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### Image with CachedNetworkImageProvider

Source: https://pub.dev/documentation/cached_network_image/latest/index.html

Use CachedNetworkImageProvider directly as the image provider for the Image widget. This allows using the cached image in other widgets.

```dart
Image(image: CachedNetworkImageProvider(url))
```

--------------------------------

### timeDilation getter

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/timeDilation.html

A top-level property that returns a double value representing the time dilation factor. It is used to slow down animations for development purposes.

```APIDOC
## timeDilation getter

### Description
Slows down animations by this factor to help in development.

### Declaration
```dart
double get timeDilation
```

### Implementation
```dart
double get timeDilation => _timeDilation;
```

### Return Value
- **double** - The current time dilation factor.
```

--------------------------------

### timeDilation getter implementation

Source: https://pub.dev/documentation/cached_network_image/latest/cached_network_image/timeDilation.html

Returns the current time dilation factor as a double. Used to slow down animations for development purposes.

```dart
double get timeDilation => _timeDilation;
```
Tokens:
Raw