rnkit-excard-idcard v1.0.0

易道博识-图像识别 for React Native.

此分支只支持 身份证 识别, 如需其它请到 Master 分支获取.

Support me with a Follow

Getting Started

First, cd to your RN project directory, and install RNMK through rnpm . If you don't have rnpm, you can install RNMK from npm with the command npm i -S rnkit-excard-idcard and link it manually (see below).

iOS

• React Native < 0.29 (Using rnpm)

  rnpm install rnkit-excard-idcard

• React Native >= 0.29

  $npm install -S rnkit-excard-idcard

  $react-native link rnkit-excard-idcard

Manually

1. Add node_modules/rnkit-excard-idcard/ios/RNKitExcard.xcodeproj to your xcode project, usually under the Libraries group
2. Add libRNKitExcard.a (from Products under RNKitExcard.xcodeproj) to build target's Linked Frameworks and Libraries list
3. Add ocr framework to $(PROJECT_DIR)/Frameworks.

Android

• React Native < 0.29 (Using rnpm)

  rnpm install rnkit-excard-idcard

• React Native >= 0.29

  $npm install -S rnkit-excard-idcard

  $react-native link rnkit-excard-idcard

Manually

1. JDK 7+ is required

2. Add the following snippet to your android/settings.gradle:

   include ':rnkit-excard-idcard'
   project(':rnkit-excard-idcard').projectDir = new File(rootProject.projectDir, '../node_modules/rnkit-excard-idcard/android/app')

3. Declare the dependency in your android/app/build.gradle

   dependencies {
       ...
       compile project(':rnkit-excard-idcard')
   }

4. Import import io.rnkit.excard.EXOCRPackage; and register it in your MainActivity (or equivalent, RN >= 0.32 MainApplication.java):

   @Override
   protected List<ReactPackage> getPackages() {
       return Arrays.asList(
               new MainReactPackage(),
               new EXOCRPackage()
       );
   }

5. Add Module ExBankCardSDK And ExCardSDK In Your Main Project.

Finally, you're good to go, feel free to require rnkit-excard-idcard in your JS files.

Have fun! :metal:

Basic Usage

Import library

import RNKitExcard from 'rnkit-excard-idcard';

Init

RNKitExcard.config({
  DisplayLogo: false
  ....
})

Init Params

OrientationMask

• Portrait
• LandscapeLeft
• LandscapeRight
• PortraitUpsideDown
• Landscape
• MaskAll
• AllButUpsideDown

一、身份证识别

1. 使用摄像头、相册识别

try {
	const bFront = true  // 身份证方向，true-正面，false-背面
	const result = await RNKitExcard.recoIDCardFromStreamWithSide(bFront);
} catch (error) {
	if (error.code === -1) {
		console.log('on cancel')
	} else {
		console.log(error)
	}
}

2. 使用远程或本地图片识别

try {
	const imagePath = '...';
	const result = await RNKitExcard.recoIDCardFromStillImage(imagePath);
} catch (error) {
	if (error.code === -1) {
		console.log('on cancel')
	} else {
		console.log(error)
	}
}

返回值

二、常量

const sdkVersion = RNKitExcard.sdkVersion;
const kernelVersion = RNKitExcard.kernelVersion;

三、clean 清理图片临时目录

try {
	const result = await RNKitExcard.clean();
} catch (error) {
	console.log(error)
}

Contribution

• @simamn The main author.

Questions

Feel free to contact me or create an issue

made with ♥