Get started integrating Apryse React Native SDK

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.

• 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)

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

1yarn global add react-native-cli

1npm install -g react-native-cli

1. Initialize the project by running the following command:

1react-native init MyApp

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

1cd 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

1yarn add github:PDFTron/pdftron-react-native
2yarn add @react-native-community/cli --dev
3yarn add @react-native-community/cli-platform-android --dev
4yarn add @react-native-community/cli-platform-ios --dev
5yarn install

1npm install github:PDFTron/pdftron-react-native --save
2npm install @react-native-community/cli --save-dev
3npm install @react-native-community/cli-platform-android --save-dev
4npm install @react-native-community/cli-platform-ios --save-dev
5npm install

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

1yarn add @pdftron/react-native-pdf
2yarn add @react-native-community/cli --dev
3yarn add @react-native-community/cli-platform-android --dev
4yarn add @react-native-community/cli-platform-ios --dev
5yarn install

1npm install @pdftron/react-native-pdf
2npm install @react-native-community/cli --save-dev
3npm install @react-native-community/cli-platform-android --save-dev
4npm install @react-native-community/cli-platform-ios --save-dev
5npm install

1. Open Podfile in the ios folder, add:

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

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

1cd ios

1pod 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.

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.

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.

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.