cordova-plugin-photoeditorsdk

Cordova & Ionic plugin for PhotoEditor SDK

Getting started

Add PhotoEditor SDK plugin to your project as follows:

cordova plugin add cordova-plugin-photoeditorsdk

Android

From version 3.0.0 the plugin uses AndroidX. To enable AndroidX in your application please adjust your config.xml:

<platform name="android">
...
+    <preference name="AndroidXEnabled" value="true" />
...
</platform>

If your application is using legacy Android Support Libraries you can use the cordova-plugin-androidx-adapter which will migrate the legacy libraries to work with AndroidX.

Kotlin Version

If you are using cordova-android version 10.0+, you might need to adjust the Kotlin version of your application in your config.xml, if your current Kotlin version is not compatible with our plugin:

<platform name="android">
...
+    <preference name="GradlePluginKotlinVersion" value="1.4.10" />
...
</platform>

Module Configuration

You can configure the modules used for the PhotoEditor SDK for Android by opening imglyConfig.gradle and removing / commenting out the modules you do not need. This will also reduce the size of your application.

Because PhotoEditor SDK for Android with all its modules is quite large, there is a high chance that you will need to enable Multidex for your project as follows:

cordova plugin add cordova-plugin-enable-multidex

Usage

Each platform requires a separate license file. Unlock PhotoEditor SDK with a single line of code for both platforms 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');

Open the editor with an image:

PESDK.openEditor(
  successCallback,
  failureCallback,
  PESDK.resolveStaticResource('www/assets/image.jpg')
);

Please see the code documentation for more details and additional customization and configuration options.

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.

Example

Please see our example project which demonstrates how to use the Cordova plugin for PhotoEditor SDK.

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.

Changelog

[3.1.0]

Changed

• Updated documentation for remote resources used in the editor. Remote resources are usable but not optimized and therefore should be downloaded in advance and then passed to the editor as local resources.

Added

• Added integration and documentation for custom watermark.

Fixed

• [Android] Fixed hook execution would fail for cordova-android version 10.0+.