Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chukwu/ionic3-image-cache

A Simple Ionic Image Cache for all types of images with preview modal
https://github.com/chukwu/ionic3-image-cache

angular6 component ionic3 ionicframework module

Last synced: 3 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/chukwu/ionic3-image-cache
Owner: chukwu
Created: 2018-07-14T04:29:58.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2019-08-14T09:13:06.000Z (over 5 years ago)
Last Synced: 2024-10-13T23:03:02.593Z (3 months ago)
Topics: angular6, component, ionic3, ionicframework, module
Language: TypeScript
Size: 49.8 KB
Stars: 12
Watchers: 3
Forks: 9
Open Issues: 14
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

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`](https://github.com/driftyco/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](https://media.giphy.com/media/FPhRVb6Qo7rVVjGsKy/giphy.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](https://github.com/apache/cordova-plugin-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**
```typescript
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:
```html

```

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

```

...

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

## HTML attributes
The `` component takes many attributes that allows you to customize the image. You can use the following table as a reference:
```

| Attribute Name | Type | Description | Default Value |
| --- | --- | --- | --- |
| src | string | The image URL | N/A |
| isAvatar | boolean | Sets an avatar image as a placeholder rather than image placeholder | false |
| showPreview | boolean | Displays a full screen version of the image with gestures. | true |
| imgCssClass | string | You can inject css classes to the image | N/A |
| highResSrc | string | Set a highres image to use for image preview on click when showPreview is set to true | Original Src |
| fallbackUrl | string | Sets a custom placeholder image Url while awaiting cache load | N/A |
| spinnerName | string | Set a spinner name from the list of ionic spinners list | dots |
| spinnerColor | string | Set a spinner color from your variable set at variables.scss e.g primary | Default |
| alt | string | Sets an alternative text when image fails on browser | N/A |
| enableSpinner | boolean | Enable or disable spinner | true |

**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](https://github.com/chukwu/ionic3-Image-Cache/issues/new) 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 :smile: