imgly/pesdk-react-native

React Native module for PhotoEditor SDK

React Native module for PhotoEditor SDK

Check out our video tutorial for a step-by-step integration guide which also details advanced SDK features, such as serializing and reusing previously applied editing operations.

System requirements

• React Native: 0.60
• iOS: 13
• Android: 5 (SDK 21)

Getting started

Expo CLI

Limitations

This module can not be used in the Expo Go application because it uses custom native libraries.

Usage

In order to use this module with the Expo CLI you can make use of our integrated Expo config plugin:

1. Add our module to your Expo application:

   expo install react-native-photoeditorsdk

   This will automatically install react-native-imglysdk which you can use to configure your application with our Expo config plugin.

2. Inside your app's app.json or app.config.js add our config plugin:

   {
     "plugins": ["react-native-imglysdk"]
   }

   If needed, you can also use a specific version of our native library for Android as well as define explicitly the included modules. By default, all modules for both PhotoEditor SDK and VideoEditor SDK are included. Further, you can alternate the KSP version with the kspVersion parameter based on the Kotlin version you are using. Please take a look here on further details. s For Expo version < 45, you can configure the buildToolsVersion, minSdkVersion, compileSdkVersion, targetSdkVersion, and kotlinGradlePluginVersion. From version 45+ we recommend setting these properties using the expo-build-properties config plugin directly.

   {
     "plugins": [
       [
         "react-native-imglysdk",
         {
           "android": {
             "version": "10.9.0",
             "kspVersion": "1.8.0-1.0.9",
             "modules": [
               "ui:core",
               "ui:transform",
               "ui:filter",
               "assets:filter-basic"
             ],
             "buildToolsVersion": "34.0.0",
             "minSdkVersion": "21",
             "compileSdkVersion": "34",
             "targetSdkVersion": "34",
             "kotlinGradlePluginVersion": "1.8.0"
           }
         }
       ]
     ]
   }

   For further information on the available modules, please refer to step 4 of the React Native CLI Android guide below.

   Please note that the react-native-imglysdk module manages both VideoEditor SDK as well as PhotoEditor SDK so you only need to add the Expo config plugin once even when using both SDKs.

3. From version 2.15.0 the iOS deployment target needs to be set to at least iOS 13. You can use the expo-build-properties config plugin for this. Please refer to the official Expo docs.

4. The changes will be applied on expo prebuild or during the prebuild phase of eas build.

For further information on how to integrate Expo config plugins please also refer to the official docs.

React Native CLI

Install the React Native module in your project as follows:

yarn add react-native-photoeditorsdk

In general, we highly recommend using React Native 0.60 or newer. If you cannot avoid using an older React Native version you need to link the native dependencies with:

yarn react-native link

before you continue with the platform-specific guides below.

iOS

For React Native 0.60 and newer autolinking is used and PhotoEditor SDK for iOS should be automatically installed:

cd ios && pod install && cd ..

and updated:

cd ios && pod update && cd ..

with CocoaPods.

For older React Native versions autolinking is not available and PhotoEditor SDK for iOS needs to be manually integrated in your Xcode project if you don't use CocoaPods to manage your dependencies. Make sure to put ImglyKit.framework and PhotoEditorSDK.framework in the ios/ directory of your project.

Android

1. Add the IMG.LY repository and plugin by opening the android/build.gradle file (not android/app/build.gradle) and adding these lines at the top:

   buildscript {
       repositories {
           mavenCentral()
           maven { url "https://artifactory.img.ly/artifactory/imgly" }
       }
       dependencies {
           classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.0"
           classpath 'com.google.devtools.ksp:com.google.devtools.ksp.gradle.plugin:1.8.0-1.0.9' // KSP version is depending on your Kotlin version.
           classpath 'ly.img.android.sdk:plugin:10.9.0'
       }
   }

   The KSP version depends on the Kotlin version that you are using. In order to find the correct version, please visit the official KSP release page.

   In order to update PhotoEditor SDK for Android replace the version string 10.9.0 with a newer release.

2. Still in the android/build.gradle file (not android/app/build.gradle), add these lines at the bottom:

   allprojects {
       repositories {
           maven { url 'https://artifactory.img.ly/artifactory/imgly' }
       }
   }

3. In the same file, you will need to modify the minSdkVersion to at least 21. We also recommend to update the buildToolsVersion to 34.0.0 or higher as well as the compileSdkVersion to 34 or higher but this is not mandatory:

   buildscript {
       ext {
   -       buildToolsVersion = "30.0.2"
   +       buildToolsVersion = "34.0.0"
   -       minSdkVersion = 19
   +       minSdkVersion = 21
   -       compileSdkVersion = 34
   +       compileSdkVersion = 34
           targetSdkVersion = 34
       }
   }

4. Configure PhotoEditor SDK for Android by opening the android/app/build.gradle file (not android/build.gradle) and adding the following lines under apply plugin: "com.android.application":

   apply plugin: 'ly.img.android.sdk'
   apply plugin: 'kotlin-android'
   
   // Comment out the modules you don't need, to save size.
   IMGLY.configure {
       modules {
           include 'ui:text'
           include 'ui:focus'
           include 'ui:frame'
           include 'ui:brush'
           include 'ui:filter'
           include 'ui:sticker'
           include 'ui:overlay'
           include 'ui:transform'
           include 'ui:adjustment'
           include 'ui:text-design'
   
           // This module is big, remove the serializer if you don't need that feature.
           include 'backend:serializer'
   
           // Remove the asset packs you don't need, these are also big in size.
           include 'assets:font-basic'
           include 'assets:frame-basic'
           include 'assets:filter-basic'
           include 'assets:overlay-basic'
           include 'assets:sticker-shapes'
           include 'assets:sticker-emoticons'
   
           include 'backend:sticker-smart'
           include 'backend:background-removal'
       }
   }

Usage

Import the module in your App.js:

import {
  PESDK,
  PhotoEditorModal,
  Configuration,
} from "react-native-photoeditorsdk";

Each platform requires a separate license file. Unlock PhotoEditor SDK with a single line of code for both platforms via platform-specific file extensions:

PESDK.unlockWithLicense(require("./pesdk_license"));

Open the editor with an image:

PESDK.openEditor(require("./image.jpg"));

Or use the component to open the editor:

<PhotoEditorModal visible={true} image={require("./image.jpg")} />

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

For configuring and customizing PhotoEditor SDK beyond these options exposed to JavaScript the iOS bridge provides an interface for native customization. Please refer to our documentation for more details on native customization.

Example

Please see our example project which demonstrates how to use the React Native module 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.