⚠️ Disclaimer

Please note that Microblink is no longer maintaining this repository.
As such, there will be no additional updates or releases for this codebase. You are welcome to continue using the code, as it remains source available.
Furthermore, if you need to update it for a newer SDK or platform version, you can do so by forking this repository and maintaining the fork independently.
If you have questions regarding such, please contact our support team at support@microblink.com.

---

BlinkInput SDK wrapper for React Native

This repository contains example wrapper for BlinkInput native SDK for Android and iOS. For 100% of features and maximum control, consider using native SDK.

Licensing

• A valid license key is required to initialize scanning. You can request a free trial license key, after you register, at Microblink Developer Hub

• Get the information about product and licensing of BlinkInput

React Native Version

BlinkInput React Native was built and tested with React Native v0.61.5

Installation

First generate an empty project if needed:

react-native init --version="0.61.5" NameOfYourProject

Add the blinkinput-react-native module to your project:

cd <path_to_your_project>
npm i --save blinkinput-react-native

Linking

iOS

Link module with your project:

react-native link blinkinput-react-native

CocoaPods is a dependency manager for Objective-C, which automates and simplifies the process of using 3rd-party libraries like BlinkInput in your projects.

• If you wish to use version v1.4.0 or above, you need to install Git Large File Storage by running these comamnds:

brew install git-lfs
git lfs install

• Be sure to restart your console after installing Git LFS

Installing pods

From react-native 0.60 CocoaPods are now part of React Native's iOS project.

Go to NameOfYourProject/ios folder and install Pods

pod install

Our blinkinput-react-native depends on latest PPBlinkOCR pod so it will be installed automatically.

To run iOS application, open NameOfYourProject.xcworkspace, set Your team for every Target in General settings and add Privacy - Camera Usage Description key to Your info.plist file and press run

Android

Add microblink maven repository to project level build.gradle:

allprojects {
  repositories {
    // don't forget to add maven and jcenter
    mavenLocal()
    jcenter()
    
    // ... other repositories your project needs
    
    maven { url "http://maven.microblink.com" }
  }
}

Demo

This repository contains initReactNativeDemoApp.sh script that will create React Native project and download all of its dependencies. You can run this script with following command:

./initReactNativeDemoApp.sh

Usage

To use the module you call it in your index.android.js or index.ios.js file like in the example app. Available recognizers and API documentation is available in JS API files.

FAQ

Can I create a custom UI overlay?

Yes you can, but you will have to implement it natively for android and ios, you can see native implementation guides here(Android) and here(ios).

Known react-native problems:

Android build exception - missing ReactSwipeRefreshLayout

java.lang.NoClassDefFoundError: com.facebook.react.views.swiperefresh.ReactSwipeRefreshLayout

Add the following line to dependencies section in android/app/build.gradle:

implementation 'androidx.swiperefreshlayout:swiperefreshlayout:1.1.0-alpha02'