cordova-plugin-icrop

cordova-plugin-icrop

Crop an image in a Cordova app

Install

$ cordova plugin add --save cordova-plugin-icrop

& cordova plugin add https://github.com/isathyam/cordova-plugin-icrop.git

NOTE: Make sure your Cordova CLI version is 5.0.0+ (check with cordova -v). Cordova 4.x and below uses the now deprecated Cordova Plugin Registry as its plugin repository, so using a version of Cordova 4.x or below will result in installing an old version of this plugin.

Usage

plugins.crop(function success () {

}, function fail () {

}, '/path/to/image', options)

or, if you are running on an environment that supports Promises (Crosswalk, Android >= KitKat, iOS >= 8)

plugins.crop.promise('/path/to/image', options)
.then(function success (newPath) {

})
.catch(function fail (err) {

})

Ionic V1

window.plugins.icrop('/path/to/image', options)
.then(function success (newPath) {
	console.log("Cropped image path: " + newPath);
	// crop result
})
.catch(function fail (err) {
	console.log(err)
})

API

• quality: Number

The resulting JPEG quality. default: 100

Ionic / Typescript Example Angular 2 Service

This is an example service that uses ionic-native's built in camera and the cordova-plugin-icrop to created a cropped version of the image and return the file path.

import { Injectable } from '@angular/core';
import { Platform } from 'ionic-angular';
import { Camera } from 'ionic-native';

declare var plugins: any;

@Injectable()
export class CameraService {

  public options: any = {
        allowEdit: true,
        sourceType: Camera.PictureSourceType.SAVEDPHOTOALBUM,
        mediaType: Camera.MediaType.ALLMEDIA,
        destinationType: Camera.DestinationType.FILE_URI
  }
  
  constructor(public platform: Platform) {}

  // Return a promise to catch errors while loading image
  getMedia(): Promise<any> {
    return new Promise((resolve, reject) => {
      // Get Image from ionic-native's built in camera plugin
      Camera.getPicture(this.options).then((fileUri) => {
        // Crop Image, on android this returns something like, '/storage/emulated/0/Android/...'
        // Only giving an android example as ionic-native camera has built in cropping ability
        if (this.platform.is('android') {
          // Modify fileUri format, may not always be necessary
          fileUri = 'file://' + fileUri;
          const options = { quality: 100 };
          /* Using cordova-plugin-icrop starts here */
          plugins.crop.promise(fileUri, options).then( (path) => {
            // path looks like 'file:///storage/emulated/0/Android/data/com.foo.bar/cache/1477008080626-cropped.jpg?1477008106566'
            console.log('Cropped Image Path!: ' + path);
            // Do whatever you want with new path such as read in a file
            // Here we resolve the path to finish, but normally you would now want to read in the file
            resolve(path);
          }).catch( (error) => {
            reject(error);
          });
        }
      }).catch((error) => {
        reject(error);
      }
    });
  }
  
}  

Libraries used

• iOS: PEPhotoCropEditor
• Android: android-ucrop

License

MIT © Sathyanarayana