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 23+
• React Native: 0.60+

Setup

Installation

From your React Native root folder:

npm install @thegrizzlylabs/react-native-genius-scan@6.0.0-beta11 --save

For React Native versions below 0.60, you will also need to link the plugin:

react-native link @thegrizzlylabs/react-native-genius-scan

Android configuration

Open the android/build.gradle file and make the following changes:

1. Make sure minSdkVersion is 23 or higher. If your React Native template already uses a higher value, keep it.
2. 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. In your Podfile, this is usually configured with:

platform :ios, '15.0'

1. Run pod install from the ios folder:

cd ios && pod install

TypeScript projects

If TypeScript reports that SDK 6 scan configuration fields such as skipPostProcessingScreen or requiredReadabilityLevel do not exist on ScanOptions with 6.0.0-beta11, add a local declaration file until you upgrade to a package version with updated declarations:

import '@thegrizzlylabs/react-native-genius-scan';

declare module '@thegrizzlylabs/react-native-genius-scan' {
  export interface ScanOptions {
    skipPostProcessingScreen?: boolean;
    requiredReadabilityLevel?: 'lowest' | 'low' | 'medium' | 'high' | 'highest';
  }
}

What’s Next?

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