Skip to content

README.md

Latest commit

 

History

History
77 lines (57 loc) · 2.83 KB

README.md

File metadata and controls

77 lines (57 loc) · 2.83 KB
Raw

Mobile Document Scanner JavaScript Edition

Dynamsoft's Mobile Document Scanner JavaScript Edition (MDS) is a web SDK for scanning documents in the browser. MDS captures images of documents with automatic border detection, applies perspective correction, and enhances the results to professional standards — all behind a ready-made, mobile-first UI launched with a few lines of code.

User Guide · API Reference · Live Demo

Install

npm install @dynamsoft/document-scanner

Both engines — Dynamsoft Capture Vision and Dynamsoft Document Viewer — are peer dependencies, and are installed alongside it.

Or load the script build from a CDN, which bundles both engines:

<script src="https://cdn.jsdelivr.net/npm/@dynamsoft/document-scanner@2.0.0/dist/document-scanner.iife.js"></script>

Quick Start

MDS requires a license key to run — request a free 30-day trial license through the customer portal.

<script src="https://cdn.jsdelivr.net/npm/@dynamsoft/document-scanner@2.0.0/dist/document-scanner.iife.js"></script>
<script type="module">
	const scanner = new Dynamsoft.DocumentScanner({ license: "YOUR_LICENSE_KEY_HERE" });

	const result = await scanner.scan();
	if (result.status === "success") {
		// result.pages carries the scanned pages; result.output, the file.
	}
</script>

Alternatively, clone this repository and run the Hello World page against the source:

pnpm install
pnpm run dev

Then open hello-world.html at the address the dev server prints.

Documentation

The full documentation lives on the MDS documentation site:

  • User Guide — the Hello World sample explained, deployment tips, multi-page scanning, workflow and UI customization.
  • API Reference — generated from the TSDoc in this repository's source.

For multi-document processing with advanced editing features, see the Mobile Web Capture (MWC) sample project — read its User Guide.

License