iic
ionic3-image-cache
npm i ionic3-image-cache
iic

ionic3-image-cache

A Simple Ionic Image Cache for all types of images with preview modal

by Chukwu Ifeanyi

0.1.4 (see all)License:MITTypeScript:Built-In
npm i ionic3-image-cache
Readme

ionic3-Image-Cache

A rewrite of Ionic Image Loader library that fixes the SVG issues, local URL detection and base64 detection yet maintaining all other major features. This Ionic plugin also includes features such as image preview. Hats of to @riron for Image viewer

Ionic Module that loads images in a background thread and caches them for later use. Uses FileTransfer from cordova-plugin-filetransfer, and cordova-plugin-file via ionic-native wrappers. This module helps to save Http requests to the server all the time thereby saving bandwidth and other HTTP related issues.

Gif

Features

  • Downloads images via a native thread. Images will download faster and they will not use the Webview's resources.
  • Preview images on click or tap - (can be disabled)
  • Caches images for later use. Remote URLs are counter matched with the file system file and returned.
  • Shows a loading spinner while the images are loading. (can be disabled and customised with other spinner names in ionic)
  • Allows setting a fallback image to be displayed in case the image you're trying to show doesn't exist on the web. (optional)
  • Works with the WKWebView Engine (iOS), as the images are copied to the temporary directory, which is accessible form within the WebView

Installation

1. Install the NPM Package

npm install --save ionic3-image-cache

2. Install Required Plugins and Dependency

npm i --save @ionic-native/file
ionic cordova plugin add cordova-plugin-file
npm install --save @ionic-native/file-transfer
ionic cordova plugin add cordova-plugin-file-transfer
npm install --save ionic-img-viewer

3. Import IonicImageCacheModule module

Add IonicImageCacheModule.forRoot() in your app's root module

import {IonicImageCacheModule} from 'ionic3-image-cache';

// import the module
@NgModule({
  ...
  imports: [
    IonicImageCacheModule.forRoot()
  ]
})
export class AppModule {}

Usage

Basic Usage

This HTML code demonstrates basic usage of this module:

<ionic-image-cache [src]="this.sender.profile_image.url"></ionic-image-cache>

<ionic-image-cache [isAvatar]="'true'" [showPreview]="'false'" (tap)="whatever($event)" [src]="this.sender.profile_image.url" class="img-circle"></ionic-image-cache>

You can also listen to the load event to be notified when the image has been loaded:

<ionic-image-cache [src]="this.sender.profile_image.url" (loaded)="onImageLoad($event)"></ionic-image-cache>

...

onImageLoad(data) { // do something with the loader }


## HTML attributes
The `<ionic-image-cache>` component takes many attributes that allows you to customize the image. You can use the following table as a reference:
Attribute NameTypeDescriptionDefault Value
srcstringThe image URLN/A
isAvatarbooleanSets an avatar image as a placeholder rather than image placeholderfalse
showPreviewbooleanDisplays a full screen version of the image with gestures.true
imgCssClassstringYou can inject css classes to the imageN/A
highResSrcstringSet a highres image to use for image preview on click when showPreview is set to trueOriginal Src
fallbackUrlstringSets a custom placeholder image Url while awaiting cache loadN/A
spinnerNamestringSet a spinner name from the list of ionic spinners listdots
spinnerColorstringSet a spinner color from your variable set at variables.scss e.g primaryDefault
altstringSets an alternative text when image fails on browserN/A
enableSpinnerbooleanEnable or disable spinnertrue

Note: Upcoming features. Please contribute your features.

  • Typescript options from controller
  • Clear cache
  • Max cache settings
  • Cache lifespan



Contribution

  • Having an issue? or looking for support? Open an issue and we will get you the help you need.
  • Got a new feature or a bug fix? Fork the repo, make your changes, and submit a pull request.

Support this project

If you find this project useful, please star the repo to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you 😄

Downloads/wk

37

GitHub Stars

12

LAST COMMIT

4yrs ago

MAINTAINERS

1

CONTRIBUTORS

2

OPEN ISSUES

13

OPEN PRs

1
VersionTagPublished
0.1.4
latest
4yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100
No reviews found
Be the first to rate