反应 - 内存 - 文档扫描器

Fast, 本地 React Industrial 文档扫描仪用于iOS和Android,使用Apple VisionKit(iOS)和Google ML Kit(Android). 特性为自动文档检测,边缘/透视校正,多 页扫描,可配置图像质量,可选 Base64,以及支持在ios和和 android上的回放原生新建筑.

• iOS系统: 使用 VisionKit 框架和 VNDocumentCameraView 控制器
• 机器人: 使用 ML Kit 文档扫描器 API

预览

iOS 演示	Android Demo 软件

用于生产应用软件

FileNest AI - Docs 组织器	MyGarage - 汽车Docs和历史	我的书目

特征

• QQ跨平台支持(iOS 13+和Android API 21+)
• QQ iOS & Android: 全面支持新的 React Introduct 架构(Fabric/TurboModules) 互联网档案馆的存檔,存档日期2013-12-21
• 自动文档检测和扫描
• 多页文档扫描
• 配置图像质量
• QQ 可选最大宽度/ 高度以盖住图像大小
• & & Android: 可选的 PDF 输出和可配置的 ML Kit 扫描器( 页数限制、 画廊导入、 扫描器模式)
• QQ 可选基础64 编码
• QQ 平台均等 - 两个平台的相同API

关键词:回放原生文档扫描仪,VisionKit文档扫描仪,ML Kit文档扫描仪,回放原生文档,回放边缘检测,视角校正,多页扫描仪

安装

从 npm (建议)

npm install @dariyd/react-native-document-scanner

或带线:

yarn add @dariyd/react-native-document-scanner

从 GitHub (最新开发)

npm install https://github.com/dariyd/react-native-document-scanner.git

或者说

yarn add https://github.com/dariyd/react-native-document-scanner.git

iOS 安装

cd ios && pod install

Android 安装

无需额外步骤。 ML Kit 依赖将被自动包含在内.

安装后步骤

iOS系统

添加数据 NSCameraUsageDescription 键 Info.plist数字 :

<key>NSCameraUsageDescription</key>
<string>We need access to your camera to scan documents</string>

机器人

添加相机权限到您的 AndroidManifest.xml数字 :

<uses-permission android:name="android.permission.CAMERA" />

模块在发射扫描仪时自动请求相机许可.

反应原生新建筑

此模块需要 0.77.3或以上反应 并支持iOS上的新架构,同时使用Android上的稳定旧架构.

iOS系统: 完全支持 Fabric 和 TurboModules - 当您在您的工程中启用新架构时自动检测并启用 .

机器人: 使用稳定桥执行来达到最大兼容性. 计划为今后的发行提供新架构支持.

所需资源

• 0.77.3或以上反应
• 反应18.2.0或以上
• iOS 13.0 或更高
• 机器人数字 :
  • 最低SDK: API 21 (Android 5.0) (英语)
  • 目标SDK:API 35 (Android 15) - 由Google Play Store要求
  • 编译 SDK: API 35

启用新架构

iOS系统: 完全支持 - 设定 RCT_NEW_ARCH_ENABLED=1 或构建设置

安卓尔: 完全支持 - 保留 newArchEnabled=true 在你身边 gradle.properties

IOS实施在启用时会自动使用Fabric/TurboModules,而Android则会继续使用稳定的桥实施.

使用量

import { launchScanner } from 'react-native-document-scanner';

// Basic usage
const result = await launchScanner();

// With options
const result = await launchScanner({
  quality: 0.8,
  includeBase64: false,
});

// With EXIF metadata
const result = await launchScanner({
  quality: 0.8,
  includeExif: true,
});
console.log('EXIF:', result.images[0].exif);

// With EXIF + GPS location
const result = await launchScanner({
  quality: 0.8,
  includeExif: true,
  includeLocationExif: true,
});
console.log('GPS:', result.images[0].exif?.GPSLatitude, result.images[0].exif?.GPSLongitude);

// Cap image size (e.g. to keep uploads small)
const result = await launchScanner({
  quality: 0.85,
  maxWidth: 2048,
  maxHeight: 2048,
});

// Android only: configure the ML Kit scanner and get a PDF too
// (these options are ignored on iOS, `result.pdf` is never set there)
const result = await launchScanner({
  pageLimit: 20,
  galleryImportAllowed: true,
  scannerMode: 'base_with_filter',
  includePdf: true,
});
console.log('Images:', result.images);
if (result.pdf) {
  console.log('PDF:', result.pdf.uri, result.pdf.pageCount, 'pages');
}

// With callback (optional)
launchScanner({ quality: 0.9 }, (result) => {
  if (result.didCancel) {
    console.log('User cancelled');
  } else if (result.error) {
    console.log('Error:', result.errorMessage);
  } else {
    console.log('Scanned images:', result.images);
  }
});

API 参考

方法

import {launchScanner} from 'react-native-document-scanner';

launchScanner()

启动扫描仪扫描文件.

见 选项 详情请查阅 options。 。 。 .

这个 callback 将调用一个响应对象,参见 响应对象。 。 。 .

选项

以上四个选项配置 ML Kit 扫描仪, 并且是 忽略在 iOS 上 ——通过它们是安全的,它们在那里根本就没有效果.

扫描器模式( 只有Android)

响应对象

图像对象

PDF 对象( 只有Android)

何时 includePdf 实值 true 在Android上,反应中还包含一个 pdf 对象。 它从来没有出现在iOS上.

⚠️ PDF 由 ML Kit 以自己的分辨率构建. 这个 quality, (中文(简体) ), maxWidth 编号 : maxHeight 财务报告和审定财务报表 includeExif 编号 : includeLocationExif 选项仅适用于 images, (中文(简体) ), 没有 转到 PDF.

EXIF 对象

何时 includeExif 实值 true,每个图像包含 exif 对象,有下列字段:

位置权限设置

使用时 includeLocationExif: true,软件包需要时请求位置许可(除非 requestLocationPermission: false) (中文(简体) ). 您必须在您的应用程序中添加所需的权限密钥 :

iOS系统

添加到您的 Info.plist数字 :

<key>NSLocationWhenInUseUsageDescription</key>
<string>Your location will be embedded in scanned documents for record-keeping.</string>

机器人

不需要额外设置。 软件包声明 ACCESS_FINE_LOCATION 财务报告和审定财务报表 ACCESS_COARSE_LOCATION 权限在自己的列表中,该列表将自动合并.

允许行为

• 如果需要许可级别 locationAccuracy 已经 尚未获准,系统对话框在相机打开前出现——要求精确的这个关卡(近似于 'approximate',准确的除外)
• 如果授权是 已经批准 在该级别上,没有显示对话框
• 如果授权是 被拒绝,GPS 字段会默默跳过,扫描结果通常
• 与 requestLocationPermission: false 扫描仪 永远 显示对话框 —— 如果您想要 GPS , 请在扫描前询问应用程序中的位置
• 位置权限是 仅在 includeLocationExif: true 它没有其他效果

地点精确度

地点是 最好不要拖延摄像头。扫描仪立即打开;使用最近缓存的固定(5分钟以下),在用户扫描时进行位置更新,保持最准确的固定。 更新一旦固定到 locationAccuracy 目标,或扫描仪关闭时。 获得的最佳固定值在扫描保存时被嵌入—— GPSHorizontalAccuracy 财务报告和审定财务报表 GPSDateTimeUTC 告诉你它有多精确 和何时被取走.

如果在请求精确关卡时只给予近似许可,则嵌入了最佳近似固定. 一个没有缓存固定的非常快的扫描,或者没有位置信号(例如没有最近固定的飞机模式),只是产生一个没有GPS的图像.

iOS:没有位置的建筑

位置代码被构建在您的应用程序中, 即使你从未设置 includeLocationExif,所以 App Store 连接可能会警告丢失 NSLocationWhenInUseUsageDescription (ITMS-90683) (英语). 如果你的应用从未使用 includeLocationExif中,通过在顶部附近添加此行,留下位置代码 ios/Podfile运行 pod install数字 :

ENV['RNDS_DISABLE_LOCATION'] = '1'

您也可以设定为一次运行 : RNDS_DISABLE_LOCATION=1 pod install由于位置被忽略, includeLocationExif 警告在发展中被忽略.

平台差异

虽然这两个平台提供类似的功能,但有一些细微的差异:

iOS系统

• 使用本地视野框架
• 需要iOS 13.0或更高
• 支持 PNG 质量格式 = 1.0, JPEG 质量 < 1.0

机器人

• 使用 Google ML Kit 文档扫描器
• 最低SDK: API 第21级 (Android 5.0)
• 目标SDK:API 第35级(Android 15) - Google Play Store要求
• 总是输出 JPEG 格式( 当 includePdf 事实)
• 扫描仪行为可以通过 pageLimit, (中文(简体) ), galleryImportAllowed, (中文(简体) ), scannerMode ——无iOS等同
• 需要谷歌游戏服务

解决问题

Android: ML Kit 无法使用

如果你遇到关于Android的ML Kit的问题,确保:

1. Google 游戏服务安装在设备/模拟器上
2.  compileSdkVersion 35岁或以上
3.  targetSdkVersion 35 (由 Google Play Store 所要求)
4.  minSdkVersion 21岁或以上

iOS: 相机权限被拒绝

确保您已经添加 NSCameraUsageDescription 键 Info.plist。 。 。 .

示例

检查 example/ 显示扫描仪的完整示例应用程序的目录.

灵感来自

• iOS的执行: 反应-内生-图像采集器
• Android ML Kit: (英语) Google ML Kit 文档扫描器

许可证

麻省理工学院