Flutter Cache Image

A flutter library to cache network images. This package support the download of images from a standard network url and from a firebase gs storage url.

This package depends only on the flutter firebase storage library; there are no others external dependencies.

Images are stored in the app temporary directory.

How to add

Add to pubspec.yaml:

dependencies:
  cache_image: "^0.0.1"

Add it to your dart file:

import 'package:cache_image/cache_image.dart';

How to use

CacheImage widget can be used in two different way:

Standard network image path

return CacheImage.network(
  path: 'image_url_path',
  placeholder: new Container(
    padding: EdgeInsets.all(16.0),
    color: Colors.grey[100],
    child: new Center(
      child: new Image.asset('image_asset_path'),
    ),
  )
)

Firebase network image path

return CacheImage.firebase(
  path: 'gs_url_path',
  placeholder: new Container(
    padding: EdgeInsets.all(16.0),
    color: Colors.grey[100],
    child: new Center(
      child: new Image.asset('image_asset_path'),
    ),
  )
)

API

Widget Placeholder - Widget to display when online image isn't in cache
String Prefix - String used to parse gs firebase storage path.
Duration Duration - Animation duration between placeholder and image.
String Path - Firebase/Network image path.

[0.0.1]

Initial release, support to firebase and standard network paths.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  cache_image: ^0.0.1

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:cache_image/cache_image.dart';

Version	Uploaded	Documentation	Archive
0.0.1	Aug 12, 2018

Popularity: Describes how popular the package is relative to other packages. [more]	75
Health: Code health derived from static analysis. [more]	95
Maintenance: Reflects how tidy and up-to-date the package is. [more]	60
Overall: Weighted score of the above. [more]	78

Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

Dart: 2.0.0
pana: 0.12.4
Flutter: 0.9.5

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Fix lib/cache_image.dart. (-5 points)

Analysis of lib/cache_image.dart reported 1 warning:

line 184 col 3: This function declares a return type of 'Future<String>', but doesn't end with a return statement.

Maintenance suggestions

The description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use cache_image.dart.

Package is pre-v0.1 release. (-10 points)

While there is nothing inherently wrong with versions of 0.0.*, it usually means that the author is still experimenting with the general direction of the API.

Dependencies

Package	Constraint	Resolved
Direct dependencies
Dart SDK	>=1.19.0 < 3.0.0
firebase_storage	^1.0.1	1.0.3
flutter		0.0.0
Transitive dependencies
collection		1.14.11
firebase_core		0.2.5+1
meta		1.1.6
sky_engine		0.0.99
typed_data		1.1.6
vector_math		2.0.8
Dev dependencies
flutter_test

Dart pub

cache_image 0.0.1