Skip to content

thedumbterminal/localstorage-image-cache

Repository files navigation

localstorage-image-cache

Cache images into local storage for offline use.

Requirements

Remote images must be served from a server responding with the correct CORS headers.

For example with apache the following config can be added to a .htaccess file:

<Files *>
	Header add Access-Control-Allow-Origin "*"
</Files>

Installation

Via bower:

bower install localstorage-image-cache

Usage

This module is used in two parts, correct HTML image tag usage and a JS function to perform the image loading and caching.

To setup an image for caching.

Original image tag:

<img src="http://server.com/image.jpg">

Cacheable image tag:

<img src="somelocalloadingimage.jpg" data-src="http://server.com/image.jpg">

To load all images setup for caching on a page:

var lsic = require('localstorage-image-cache');
lsic.loadImages();

Example

See the example app in the example directory.

npm start

Will open example/index.html in your browser, hit reload and you'll notice the 2 example images are not loaded from the remote site.

Credit

The Dumb Terminal

About

Cache images into local storage for offline use

Resources

Stars

Watchers

Forks

Packages

No packages published