Get started integrating Apryse React Native SDK

Welcome to Apryse. This guide will help you integrate a free trial of the Apryse React Native SDK into your React Native Project. Your free trial includes unlimited trial usage and support from solution engineers.

Android

Android & React-Native PDF library Integration

See here for the get started guide for using the Apryse React Native SDK on iOS.

This guide will help you integrate a free trial of the Apryse SDK into your Android applications using React Native. Your free trial includes unlimited trial usage and support from solution engineers.

Get the React Native source code

Prerequisites

• Set up development environment for React Native environment

• Latest stable version of Android Studio

• Have Android NDK (Native Development Kit) installed

• Have npm or yarn setup

• Apryse SDK >= 11.0.0

• react-native >= 0.60.0

• TypeScript >= 3.4.1 (optional; see TypeScript)

No trial license key required.

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Integrate

For the expo setup of the project please refer to this blog post. For simplicity the following guide is based on a boilerplate react native app for react-native init MyApp with git diff syntax for adding and removing lines from the boilerplate app.

1. If you are using yarn, run the command to install react-native cli:or

yarn global add react-native-cli

npm install -g react-native-cli

1. Initialize the project by running the following command:

react-native init MyApp

1. In MyApp folder, install react-native-pdftron. There are two ways to integrate the SDK:

• In MyApp folder, install react-native-pdftron by calling:or

Through Apryse's github repo:

yarn add github:PDFTron/pdftron-react-native
yarn add @react-native-community/cli --dev
yarn add @react-native-community/cli-platform-android --dev
yarn add @react-native-community/cli-platform-ios --dev
yarn install

npm install github:PDFTron/pdftron-react-native --save
npm install @react-native-community/cli --save-dev
npm install @react-native-community/cli-platform-android --save-dev
npm install @react-native-community/cli-platform-ios --save-dev
npm install

• In MyApp folder, install run the following commands:or

Through Apryse's npm package:

yarn add @pdftron/react-native-pdf
yarn add @react-native-community/cli --dev
yarn add @react-native-community/cli-platform-android --dev
yarn add @react-native-community/cli-platform-ios --dev
yarn install

npm install @pdftron/react-native-pdf
npm install @react-native-community/cli --save-dev
npm install @react-native-community/cli-platform-android --save-dev
npm install @react-native-community/cli-platform-ios --save-dev
npm install

1. Add the following in your android/app/build.gradle file:

android {
    ndkVersion rootProject.ext.ndkVersion

    compileSdkVersion rootProject.ext.compileSdkVersion

    defaultConfig {
        applicationId "com.reactnativesample"
        minSdkVersion rootProject.ext.minSdkVersion
        targetSdkVersion rootProject.ext.targetSdkVersion
        versionCode 1
        versionName "1.0"
        buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+ multiDexEnabled true
+ manifestPlaceholders = [pdftronLicenseKey:PDFTRON_LICENSE_KEY]
    }

    ...
}
...

dependencies {
+ implementation "androidx.multidex:multidex:2.0.1"
    ...
}

1. In your android/gradle.properties file, add the following line:

# Add the PDFTRON_LICENSE_KEY variable here. 
# For trial purposes leave it blank.
# For production add a valid commercial license key.
PDFTRON_LICENSE_KEY=

1. Add the following to your android/app/src/main/AndroidManifest.xml file:

<manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.myapp">

  <uses-permission android:name="android.permission.INTERNET" />
  <!-- Required if you want to record audio annotations -->
+ <uses-permission android:name="android.permission.RECORD_AUDIO" />

  <application ... + android:largeHeap="true" + android:usesCleartextTraffic="false">

    <!-- Add license key in meta-data tag here. This should be inside the application tag. -->
+ <meta-data
+ android:name="pdftron_license_key"
+ android:value="${pdftronLicenseKey}"/>

    <activity ... - android:windowSoftInputMode="adjustResize" + android:windowSoftInputMode="adjustPan" + android:exported="true">
      <intent-filter>
          <action android:name="android.intent.action.MAIN" />
          <category android:name="android.intent.category.LAUNCHER" />
      </intent-filter>
    </activity>
    <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
  </application>
</manifest>

Storage Permission

Please follow the latest Android best practices and guidelines outlined here

1. In your android/app/src/main/java/com/myapp/MainApplication.java file, change Application to MultiDexApplication:

- import android.app.Application;
+ import androidx.multidex.MultiDexApplication;

- public class MainApplication extends Application implements ReactApplication {
+ public class MainApplication extends MultiDexApplication implements ReactApplication {

If your app is targeting Android SDK version 28 or higher, please make sure the android:usesCleartextTraffic="true" attribute is set in your application tag to open HTTP files in the viewer. If you are only working with HTTPS files, this is not required.

TypeScript

Apryse React Native introduced support for TypeScript in version 3.0.0. This update mainly benefits those who already use TypeScript in their applications. It also provides certain benefits to all customers, including those who use JavaScript without TypeScript.

To get access to TypeScript support, simply update your Apryse React Native dependency to version 3.0.0 or higher.

All Users

For non-TypeScript users, updating your Apryse React Native dependency to version 3.0.0 or higher will not automatically install TypeScript itself, and you can continue to use the library as before (without TypeScript support). If you currently do not use TypeScript itself in your project and would like to, see Adding TypeScript to an Existing Project.

Regardless of whether you use TypeScript, the following benefits are available:

• Proper API typings which can be used in tools such as IntelliSense. This offers insight into the data being passed without referring to the API documentation.

• Greater type safety and reliability due to the migration of source files from JavaScript to TypeScript.

• Updated Add an API guides to offer step-by-step, TypeScript-supported examples on accessing properties, methods, and events. Contributors should be aware that PRs must now be made to the dev branch (see Contributing).

If you have questions, head to the FAQ's React Native section.

TypeScript Users

If you are an existing TypeScript user, then the custom typings will be available to you simply by updating your Apryse React Native dependency to version 3.0.0 or higher.

Note:

• TypeScript version 3.4.1+ is recommended. Although compilation still works with lower versions, typings may degrade to any.

• Due to the introduction of proper typings to Apryse's APIs, your compiler may now give warnings or errors about your usage of these APIs. In most cases these will not prevent your app from running but it is advised that you address them to take full advantage of TypeScript. It is particularly important to address them if you use TypeScript to emit files and have enabled noEmitOnError in your tsconfig.json.

Next step

View a document

iOS

iOS & React-Native PDF library Integration

See here for the get started guide for using the Apryse React Native SDK on Android.

This guide will help you integrate a free trial of the Apryse SDK into your iOS applications using React Native. Your free trial includes unlimited trial usage and support from solution engineers.

Get the React Native source code

Prerequisites

• Set up development environment for React Native environment

• Latest stable version of Xcode

• Latest stable version of CocoaPods

• Have npm or yarn setup

• Apryse SDK >= 11.0.0

• react-native >= 0.60.0

• TypeScript >= 3.4.1 (optional; see TypeScript)

No trial license key required.

The trial of Apryse Mobile SDK does not require a trial key. A commercial license key is required for use in a production environment. Please contact sales to purchase a commercial key or if you need any other license key assistance.

Keep your license keys confidential.

License keys are uniquely generated. Please make sure that it is not publicly available (e.g. in your public GitHub).

Integrate

For the expo setup of the project please refer to this blog post. For simplicity the following guide is based on a boilerplate react native app for react-native init MyApp with git diff syntax for adding and removing lines from the boilerplate app.

1. If you are using yarn, run the command to install react-native cli:or

yarn global add react-native-cli

npm install -g react-native-cli

1. Initialize the project by running the following command:

react-native init MyApp

1. In the terminal change the location of the working directly to the directory of the newly created project:

cd MyApp

1. Install react-native-pdftron by calling. There are two ways to integrate the SDK:

• In MyApp folder, install react-native-pdftron by calling:or

Through Apryse's github repo:

yarn add github:PDFTron/pdftron-react-native
yarn add @react-native-community/cli --dev
yarn add @react-native-community/cli-platform-android --dev
yarn add @react-native-community/cli-platform-ios --dev
yarn install

npm install github:PDFTron/pdftron-react-native --save
npm install @react-native-community/cli --save-dev
npm install @react-native-community/cli-platform-android --save-dev
npm install @react-native-community/cli-platform-ios --save-dev
npm install

• In MyApp folder, install run the following commands:or

Through Apryse's npm package:

yarn add @pdftron/react-native-pdf
yarn add @react-native-community/cli --dev
yarn add @react-native-community/cli-platform-android --dev
yarn add @react-native-community/cli-platform-ios --dev
yarn install

npm install @pdftron/react-native-pdf
npm install @react-native-community/cli --save-dev
npm install @react-native-community/cli-platform-android --save-dev
npm install @react-native-community/cli-platform-ios --save-dev
npm install

1. Open Podfile in the ios folder, add:

target 'MyApp' do
    # ...
    pod 'PDFNet', podspec: 'https://www.pdftron.com/downloads/ios/cocoapods/pdfnet/latest.podspec'
    # ...
end

1. Change working directory to the ios folderinstall the pods by running the command:

cd ios

pod install

1. (Optional) If you need a close button icon, you will need to add the PNG resources to MyApp as well, i.e. ic_close_black_24px.

TypeScript

Apryse React Native introduced support for TypeScript in version 3.0.0. This update mainly benefits those who already use TypeScript in their applications. It also provides certain benefits to all customers, including those who use JavaScript without TypeScript.

To get access to TypeScript support, simply update your Apryse React Native dependency to version 3.0.0 or higher.

All Users

For non-TypeScript users, updating your Apryse React Native dependency to version 3.0.0 or higher will not automatically install TypeScript itself, and you can continue to use the library as before (without TypeScript support). If you currently do not use TypeScript itself in your project and would like to, see Adding TypeScript to an Existing Project.

Regardless of whether you use TypeScript, the following benefits are available:

• Proper API typings which can be used in tools such as IntelliSense. This offers insight into the data being passed without referring to the API documentation.

• Greater type safety and reliability due to the migration of source files from JavaScript to TypeScript.

• Updated Add an API guides to offer step-by-step, TypeScript-supported examples on accessing properties, methods, and events. Contributors should be aware that PRs must now be made to the dev branch (see Contributing).

If you have questions, head to the FAQ's React Native section.

TypeScript Users

If you are an existing TypeScript user, then the custom typings will be available to you simply by updating your Apryse React Native dependency to version 3.0.0 or higher.

Note:

• TypeScript version 3.4.1+ is recommended. Although compilation still works with lower versions, typings may degrade to any.

• Due to the introduction of proper typings to Apryse's APIs, your compiler may now give warnings or errors about your usage of these APIs. In most cases these will not prevent your app from running but it is advised that you address them to take full advantage of TypeScript. It is particularly important to address them if you use TypeScript to emit files and have enabled noEmitOnError in your tsconfig.json.

Next step

View a document