@cloudtasks/ngx-image

Allows you to serve highly optimized images to your Angular apps.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
20Jul 13, 2018Apr 16, 2017Minified + gzip package size for @cloudtasks/ngx-image in KB

Readme

ngx-image

npm version Build Status Codacy Badge Coverage Status devDependency Status

Github Releases

Allows you to serve highly optimized images to your client apps.

angular-cloudtasks helps using Cloudtasks.io image processing task by substituting your images sources with the processing URL.

With this you can process your images on the fly applying resize, trim, and even filters to your images. In the end you will save a lot of bandwidth for you and your users as well as improve the overall user experience.

You will need a Cloudtasks.io account to be able to use this module;

Installation

First you need to install the npm module:

npm install @cloudtasks/ngx-image --save

If you use SystemJS to load your files, you might have to update your config with this if you don't use defaultJSExtensions: true:

System.config({
    packages: {
        "ngx-image": {"defaultExtension": "js"}
    }
});

Finally, you can use ngx-image in your Angular 2 project. It is recommended to instantiate CloudtasksService in the bootstrap of your application and to never add it to the "providers" property of your components, this way you will keep it as a singleton. If you add it to the "providers" property of a component it will instantiate a new instance of the service that won't be initialized.

// component
import { Component } from '@angular/core';
import { CloudtasksService } from 'ngx-image';

@Component({
    selector: 'app',
    template: `<img [ctSrc]="'http://example.com/image.jpg'" [ctOptions]="{trim: true, smart: 'face', filters: 'blur(10):flip()'}">`
})
export class AppComponent {
    constructor(private cloudtasks: CloudtasksService) {
        // Required: set your cloudtasks.io client id
        cloudtasks.setId('YOUR_CLIENT_ID');

        // Optional: set global options
        cloudtasks.settings.options = {
            trim: false
        }
        // Optional: set global settings
        cloudtasks.settings.placeholderImage = "http://example.com/placeholderImage.jpg";
    }
}

// bootstrap
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { CloudtasksModule } from 'ngx-image';

@NgModule({
  imports: [
      BrowserModule,
      CloudtasksModule
  ],
  declarations: [ AppComponent ], 
  bootstrap: [ AppComponent ]
})

API

CloudtasksService

Settings:

  • clientId: (string) Cloudtasks.io client id
  • dev: (boolean) Set environment to dev (default: false)
  • options: (object) Global options for image processing (Docs)
  • photoWidths: (array) Array of 'Ints' to be used for width approximation calculation
  • photoHeights: (array) Array of 'Ints' to be used for height approximation calculation
  • placeholderImage: (string) Set global placeholder image url to be used while waiting for original image (default: '')

Methods:

  • setId(id: string): Sets the client id
  • getSettings(): Gets the settings

CloudtasksDirective

  • ctSrc: (string) (required) Sets original image url
  • ctOptions: (object) (optional) Sets options for image processing (Docs)
  • ctPlaceholderImage: (string) (optional) Sets placeholder image url to be used while waiting for original image
  • ctSize: (string) (optional) Sets size for image processing (if not set we will try to check the best size automatically)
  • ctForceSize: (boolean) (optional) Forces the exact size for image processing

Example:

<img [ctSrc]="'{{imgUrl}}'" ctSize="800x600" [ctOptions]="{trim: true, smart: 'face', filters: 'blur(10):flip()'}" ctPlaceholderImage="http://example.com/placeholderImage.jpg" ctForceSize="true">

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.