Skip to content

imgly/pesdk-ionic-demo

Repository files navigation

PhotoEditor SDK Logo

NPM version Platform support Twitter

PhotoEditor SDK Ionic Example App

This project shows how to integrate PhotoEditor SDK into an Ionic application with the Cordova plugin for PhotoEditor SDK which is available via NPM as cordova-plugin-photoeditorsdk.

Getting started

After cloning this repository, perform the following steps to run the example application:

  1. Add platforms to your project as follows:

    ionic cordova platform add android
    # or/and
    ionic cordova platform add ios
  2. Add PhotoEditor SDK plugin to your project as follows:

    ionic cordova plugin add cordova-plugin-photoeditorsdk
  3. Run the application:

    # run Android
    ionic cordova run android
    # run iOS
    ionic cordova run ios

Unlock the SDK

PhotoEditor SDK is a product of img.ly GmbH. Without unlocking, the SDK is fully functional but a watermark is added on top of the image preview and any exported images. In order to remove the watermark and to use PhotoEditor SDK within your app you'll need to request a license for each platform and load the license file(s) in your app with the following single line of code that automatically resolves multiple license files via platform-specific file extensions.

Rename your license files:

  • Android license: ANY_NAME.android
  • iOS license: ANY_NAME.ios

Pass the file path without the extension to the unlockWithLicense function to unlock both iOS and Android:

PESDK.unlockWithLicense('www/assets/ANY_NAME');

Notes for Ionic framework

  • Add this line above your class to be able to use PESDK.
    declare var PESDK;
  • Ionic will generate a www folder that will contain your compiled code and your assets. In order to pass resources to PhotoEditor SDK you need to use this folder.

PhotoEditor SDK for iOS & Android

The Cordova plugin for PhotoEditor SDK includes a rich set of most commonly used configuration and customization options of PhotoEditor SDK for iOS and Android. The native frameworks provide fully customizable photo editors. Please refer to our documentation for more details.

License Terms

Make sure you have a commercial license for PhotoEditor SDK before releasing your app. A commercial license is required for any app or service that has any form of monetization: This includes free apps with in-app purchases or ad supported applications. Please contact us if you want to purchase the commercial license.

Support and License

Use our service desk for bug reports or support requests. To request a commercial license, please use the license request form on our website.