Install the SDK on Cordova

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

Package information

• npm package: @thegrizzlylabs/cordova-plugin-genius-scan
• Supported platforms: iOS 15.0+, Android 24+
• Cordova requirements: cordova-cli 7.0.0+, cordova-ios 8.0.0+, cordova-android 15.1.0+

Setup

Installation

Install the plugin with the Cordova CLI:

cordova plugin add @thegrizzlylabs/cordova-plugin-genius-scan@6.6.0

After installing through the CLI, add the Android requirements below to your config.xml. Alternatively, add the plugin and requirements together:

<preference name="deployment-target" value="15.0" />
<preference name="android-minSdkVersion" value="24" />
<preference name="android-compileSdkVersion" value="37" />
<preference name="AndroidGradlePluginVersion" value="9.4.1" />
<preference name="GradleVersion" value="9.7.1" />

<engine name="ios" spec="~8.0.0" />
<engine name="android" spec="~15.1.0" />

<plugin name="@thegrizzlylabs/cordova-plugin-genius-scan" spec="6.6.0">
  <variable name="CAMERA_USAGE_DESCRIPTION" value="We use the camera to scan documents" />
</plugin>

If an existing project has an older Android platform installed, update it and save the new version before preparing the project. Keep a newer installed version:

cordova platform update android@15.1.0 --save

Then run:

cordova prepare

Platform-specific installation

You can also install for a specific platform using plugman:

# iOS
plugman install --platform ios --project ./platforms/ios --plugin @thegrizzlylabs/cordova-plugin-genius-scan

# Android
plugman install --platform android --project ./platforms/android --plugin @thegrizzlylabs/cordova-plugin-genius-scan

What’s Next?

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