跳转至正文

文档扫描仪 Capacitor 插件

扫描文档,支持自动边缘检测、透视矫正和 PDF 导出

安装

bun add @capgo/capacitor-document-scanner bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-document-scanner
  • pnpm add @capgo/capacitor-document-scanner
  • yarn add @capgo/capacitor-document-scanner

指南

如何在 Capacitor 中使用 Document Scanner

在设备上测试

下载 Capgo App,然后扫描二维码 code。

Document Scanner 插件预览二维码 code

使用 @capgo/capacitor-document-scanner

使用 Capacitor 插件在 iOS 和 Android 上扫描文档。

安装

bun add @capgo/capacitor-document-scanner
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { DocumentScanner } from '@capgo/capacitor-document-scanner';

API 概览

方法 描述
scanDocument 调用设备摄像头并开启文档扫描体验。

示例

scanDocument()

调用设备摄像头并开启文档扫描体验。

import { DocumentScanner } from '@capgo/capacitor-document-scanner';

const result = await DocumentScanner.scanDocument();
console.log(result);

完整参考文档

继续了解如何使用 @capgo/capacitor-document-scanner

如果你正在使用 使用 @capgo/capacitor-document-scanner 要规划原生插件工作,请将其与 @capgo/capacitor-document-scanner 有关 @capgo/capacitor-document-scanner 的实现细节, 快速入门 有关“入门指南”中的实现细节, Capgo 插件目录 查看 Capgo 插件目录中的产品工作流, Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节,以及 添加或更新插件 有关添加或更新插件的实现细节。

常见问题

Document Scanner 插件常见问题

如何在 Capacitor 应用中安装 Document Scanner 插件?

运行 "bun add @capgo/capacitor-document-scanner"(或 "npm install @capgo/capacitor-document-scanner"),然后运行 "bunx cap sync",使 iOS 和 Android 项目同步原生 code。最后在你的应用 code 中从 "@capgo/capacitor-document-scanner" 导入即可。

@capgo/capacitor-document-scanner 是否支持 React、Vue 和 Angular?

是的。Document Scanner 是一个 Capacitor package,因此它可以与任何在 Capacitor 中运行的 web framework 配合使用,包括 Ionic、React、Vue、Angular、Svelte 以及纯 JavaScript。

@capgo/capacitor-document-scanner 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-document-scanner 是免费开源的吗?

是的。code 的源码已在 GitHub 上公开,地址为 https://github.com/Cap-go/capacitor-document-scanner/,并且可以直接从 npm 免费安装该 package。欢迎提交 bug 报告和 pull request。

我可以在不经过 App Store 审核的情况下,更新使用了 Document Scanner 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可快速发布 Document Scanner 的更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo