Skip to main content
@capgo/capacitor-document-scanner Files & Storage Open source

Document Scanner Capacitor plugin

Scan documents with auto edge detection, perspective correction, and PDF export

Install

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

Guide

How to use Document Scanner in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

App Store Google Play
Document Scanner plugin preview QR code

Using @capgo/capacitor-document-scanner

Capacitor plugin to scan document iOS and Android.

Install

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

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

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

API at a glance

Method Description
scanDocument Opens the device camera and starts the document scanning experience.

Examples

scanDocument()

Opens the device camera and starts the document scanning experience.

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

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

Full reference

Keep going from Using @capgo/capacitor-document-scanner

If you are using Using @capgo/capacitor-document-scanner to plan native plugin work, connect it with @capgo/capacitor-document-scanner for the implementation detail in @capgo/capacitor-document-scanner, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.

FAQ

Document Scanner plugin FAQ

How do I install the Document Scanner plugin in a Capacitor app?

Run "bun add @capgo/capacitor-document-scanner" (or "npm install @capgo/capacitor-document-scanner"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-document-scanner" in your app code.

Does @capgo/capacitor-document-scanner work with React, Vue and Angular?

Yes. Document Scanner is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-document-scanner support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-document-scanner free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-document-scanner/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Document Scanner without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Files & Storage

Related plugins

Browse all plugins →

Ship Document Scanner changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo