Install the SDK on React Native

In this guide, you will learn how to get started with the Genius Scan SDK for React Native.

Package information

• npm package: @thegrizzlylabs/react-native-genius-scan
• Supported platforms: iOS 15.0+, Android 24+
• React Native (iOS): 0.60+
• React Native (Android): 0.87+

Setup

Installation

From your React Native root folder:

npm install @thegrizzlylabs/react-native-genius-scan@6.6.0 --save

Android configuration

Android builds require React Native 0.87 or later, the first React Native release that supports AGP 9. The released SDK demo uses React Native 0.87.1, AGP 9.2.1, Gradle 9.4.1, and JDK 17.

Update android/gradle/wrapper/gradle-wrapper.properties to use the matching Gradle version. For the released demo configuration, use:

distributionUrl=https\://services.gradle.org/distributions/gradle-9.4.1-bin.zip

Add the React Native AGP 9 compatibility flags to android/gradle.properties:

android.builtInKotlin=false
android.newDsl=false

Then open android/build.gradle and make the following changes:

1. Use Android Gradle Plugin 9.1.0 or later.
2. Set compileSdkVersion to 37 or higher and minSdkVersion to 24 or higher. If your React Native template already uses higher values, keep them.
3. Add the Genius Scan Maven repository:

allprojects {
    repositories {
        // ... existing repositories
        maven { url 'https://s3.amazonaws.com/tgl.maven' }
    }
}

iOS configuration

1. Add the required camera permission to your Info.plist:

<key>NSCameraUsageDescription</key>
<string>We use the camera to scan documents</string>

1. Set the iOS deployment target to at least 15.0. If your React Native template or another dependency already requires a higher value, keep the higher value.

2. Choose the dependency manager used by your React Native app:

Swift Package Manager

Swift Package Manager is supported in SDK 6.5.0 and later with React Native 0.87.1 or later. If your app still uses CocoaPods, migrate it once from your app root:

npx react-native spm --deintegrate

CocoaPods

Set the platform in your ios/Podfile:

platform :ios, '15.0'

Run pod install from the ios folder:

cd ios && pod install

What’s Next?

Next, configure a license key. To compare with a working integration, see the sample apps.