https://github.com/dynamsoft/document-scanner-javascript

Add document scanning to web apps with real-time capture, edge detection, and image enhancement. Lightweight and customizable.
https://github.com/dynamsoft/document-scanner-javascript

Last synced: about 1 month ago
JSON representation

Add document scanning to web apps with real-time capture, edge detection, and image enhancement. Lightweight and customizable.

Host: GitHub
URL: https://github.com/dynamsoft/document-scanner-javascript
Owner: Dynamsoft
License: other
Created: 2025-01-10T17:20:21.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2025-05-01T21:21:40.000Z (10 months ago)
Last Synced: 2025-06-01T16:42:50.877Z (9 months ago)
Language: TypeScript
Size: 949 KB
Stars: 0
Watchers: 4
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Scan Documents with Mobile Document Scanner

Dynamsoft's **Mobile Document Scanner JavaScript Edition (MDS)** is a web SDK designed for scanning documents. MDS captures images of the documents and enhances their quality to professional standards, making it an ideal tool for mobile document scanning.

> See it in action with the [Mobile Document Scanner Demo](https://demo.dynamsoft.com/document-scanner/).

**Table of Contents**

- [Scan Documents with Mobile Document Scanner](#scan-documents-with-mobile-document-scanner)
- [License](#license)
- [Get a Trial License](#get-a-trial-license)
- [Get a Full License](#get-a-full-license)
- [Quick Start](#quick-start)
- [Build from Source](#build-from-source)
- [Use Precompiled Script](#use-precompiled-script)
- [Self-Host Resources](#self-host-resources)
- [Download Resources](#download-resources)
- [Point to Resources](#point-to-resources)
- [Modify the Build Script](#modify-the-build-script)
- [Build the Project](#build-the-project)
- [Serve the Project Locally](#serve-the-project-locally)
- [Serve over HTTPS](#serve-over-https)
- [Set MIME Type](#set-mime-type)
- [Resource Caching](#resource-caching)
- [Hello World Sample Explained](#hello-world-sample-explained)
- [Reference MDS](#reference-mds)
- [Instantiate MDS](#instantiate-mds)
- [Launch MDS](#launch-mds)
- [Display the Result](#display-the-result)
- [Custom Usage](#custom-usage)
- [`DocumentScannerConfig` Overview](#documentscannerconfig-overview)
- [Multi-Page Scanning](#multi-page-scanning)
- [Basic Multi-Page Scanning](#basic-multi-page-scanning)
- [Explanation](#explanation)
- [Optional Settings](#optional-settings)
- [Multi-Page Scanning with DDV](#multi-page-scanning-with-ddv)
- [Explanation](#explanation-1)
- [Workflow Customization](#workflow-customization)
- [Example 1: Confine DocumentScanner UI to a Specific Container](#example-1-confine-documentscanner-ui-to-a-specific-container)
- [Example 2: Only Show `DocumentScannerView`](#example-2-only-show-documentscannerview)
- [Example 3: Specify Individual View Containers](#example-3-specify-individual-view-containers)
- [Example 4: Scan Static Image Directly](#example-4-scan-static-image-directly)
- [Example 5: Configure Scan Modes](#example-5-configure-scan-modes)
- [View-Based Customization](#view-based-customization)
- [`DocumentScannerView` Configuration](#documentscannerview-configuration)
- [Customizing the `DocumentScannerView` UI](#customizing-the-documentscannerview-ui)
- [Steps to Customize the UI for `DocumentScannerView`](#steps-to-customize-the-ui-for-documentscannerview)
- [Customizing the Scanning Region](#customizing-the-scanning-region)
- [`DocumentCorrectionView` Configuration](#documentcorrectionview-configuration)
- [Styling `DocumentCorrectionView` Buttons](#styling-documentcorrectionview-buttons)
- [Customizing Apply Button Callback](#customizing-apply-button-callback)
- [`DocumentResultView` Configuration](#documentresultview-configuration)
- [Styling `DocumentResultView` Buttons](#styling-documentresultview-buttons)
- [Customizing the "Done" Button Callback](#customizing-the-done-button-callback)
- [Customizing the "Upload" Button](#customizing-the-upload-button)
- [Next Step](#next-step)

## License

### Get a Trial License

Try **MDS** by requesting a trial license through our [customer portal](https://www.dynamsoft.com/customer/license/trialLicense?product=mwc&source=guide). The trial can be renewed twice, providing a total of two months of free access.

### Get a Full License

To purchase a full license, [contact us](https://www.dynamsoft.com/company/contact/).

## Quick Start

The following section explains how to quickly run a simple, single-page web application to scan **single page documents**. See the [**multi-page scanning guide**](#multi-page-scanning) to scan multi-page documents.

To use the **Mobile Document Scanner**, first obtain its library files. You can acquire them from one of the following sources:

1. [**GitHub**](https://github.com/Dynamsoft/document-scanner-javascript) – contains the source files for the **MDS** SDK, which can be compiled into library files.
2. [**npm**](https://www.npmjs.com/package/dynamsoft-document-scanner) – provides precompiled library files via npm for easier installation.
3. [**CDN**](https://www.jsdelivr.com/package/npm/dynamsoft-document-scanner) – delivers precompiled library files through a CDN for quick and seamless integration.

You can choose one of the following methods to set up a Hello World page:

1. **Build from source** – download the source files from GitHub and compile the library files yourself.
2. **Use precompiled scripts** – use the precompiled resource scripts from npm or the CDN for a quicker setup.
3. **Self-host resources** - self-host both MDS and its dependencies on your web server.

### Build from Source

This method retrieves all **MDS** source files from its [GitHub Repository](https://github.com/Dynamsoft/document-scanner-javascript), compiles them into a distributable package, and then runs a _ready-made_ Hello World sample page included in the repository:

1. Download **MDS** from [GitHub](https://github.com/Dynamsoft/document-scanner-javascript) as a compressed folder.

2. Extract the contents of the archive, and open the extracted directory in a code editor.

3. Set your [license key](#get-a-trial-license) in the Hello World sample:

1. Open the Hello World sample at [`/samples/hello-world.html`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/hello-world.html).
2. Search for `"YOUR_LICENSE_KEY_HERE"`, then replace it with your actual license key.

4. In the terminal, navigate to the project root directory and run the following to install project dependencies:

```shell
npm install
```

5. After installing dependencies, build the project by running:

```shell
npm run build
```

6. Start the local server by running the following to serve the project locally:

```shell
npm run serve
```

Once the server is running, open the application in a browser using the address provided in the terminal output after running `npm run serve`.

> See the server configuration details in [`/dev-server/index.js`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/dev-server/index.js).

### Use Precompiled Script

We publish **MDS** library files on [npm](https://www.npmjs.com/package/dynamsoft-document-scanner) to make them simple to reference from a CDN.

To use the precompiled script, simply include the following URL in a `` tag:

```html
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-document-scanner@1.4.0/dist/dds.bundle.js">
```

Below is the complete Hello World sample page that uses this precompiled script from a CDN.

> The code is identical to the [`/samples/hello-world.html`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/hello-world.html) file mentioned in the [Build from Source](#build-from-source) section, except for the script source.

> **Remember** to replace `"YOUR_LICENSE_KEY_HERE"` with your actual license key.

```html

Mobile Document Scanner - Hello World

Mobile Document Scanner

const resultContainer = document.querySelector("#results");
// Instantiate a Document Scanner Object
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
});
(async () => {
// Launch the scanner and wait for the result
const result = await documentScanner.launch();
console.log(result);

// Clear the result container and display the scanned result as a canvas
if (result?.correctedImageResult) {
resultContainer.innerHTML = ""; // Clear placeholder content
const canvas = result.correctedImageResult.toCanvas();
resultContainer.appendChild(canvas);
} else {
resultContainer.innerHTML = "<p>No image scanned. Please try again.</p>";
}
})();

```

To run the sample, create a new file called `hello-world.html`, then copy and paste the code above into the file. Next, serve the page directly by deploying it to a server.

If you are using VS Code, a quick and easy way to serve the project is using the [Live Server (Five Server) VSCode extension](https://marketplace.visualstudio.com/items?itemName=yandeu.five-server). Simply install the extension, open the `hello-world.html` file in the editor, and click "Go Live" in the bottom right corner of the editor. This will serve the application at `http://127.0.0.1:5500/hello-world.html`.

Alternatively, you can use other methods like `IIS` or `Apache` to serve the project, though we skip those here for brevity.

### Self-Host Resources

By default, the MDS library (whether pre-compiled or self-compiled) fetches resource files (Dynamsoft `node` dependencies and an HTML UI template) from CDNs. Self-hosting library resources gives you full control over hosting your application. Rather than using CDNs to serve these resources, you can instead host these resources on your own servers to deliver to your users directly when they use your application. You can also use this option to host MDS fully offline by pointing to local resources.

#### Download Resources

First, download a copy of the resources:

1. Download **MDS** from [GitHub](https://github.com/Dynamsoft/document-scanner-javascript) as a compressed folder.

2. Extract the contents of the archive, and open the extracted directory in a code editor.

3. Set your [license key](#get-a-trial-license) in the Hello World sample:

1. Open the Hello World sample at ([`/samples/hello-world.html`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/hello-world.html)).

2. Search for `"YOUR_LICENSE_KEY_HERE"`, then replace it with your actual license key.

4. In the terminal, navigate to the project root directory and run the following to install project dependencies:

```shell
npm install
```

#### Point to Resources

The library uses [`engineResourcePaths`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#engineresourcepaths) to locate required Dynamsoft `node` dependencies by pointing to the location of the resources on your web server. The library also uses `scannerViewConfig.cameraEnhancerUIPath` similarly to set the path for the HTML UI template of the `ScannerView`. Later steps will place both the `node` dependencies and the HTML template in the local `dist` directory. Therefore, set `engineResourcePaths` in the MDS constructor to point to the local `dist` directory (along with setting your license key, and all other configurations):

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE",
scannerViewConfig: {
cameraEnhancerUIPath: "./dist/document-scanner.ui.xml", // Use the local file
},
engineResourcePaths: {
std: "./dist/libs/dynamsoft-capture-vision-std/dist/",
dip: "./dist/libs/dynamsoft-image-processing/dist/",
core: "./dist/libs/dynamsoft-core/dist/",
license: "./dist/libs/dynamsoft-license/dist/",
cvr: "./dist/libs/dynamsoft-capture-vision-router/dist/",
ddn: "./dist/libs/dynamsoft-document-normalizer/dist/",
},
});
```

API Reference:

- [`DocumentScanner()`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscanner)
- [`DocumentScannerConfig`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscannerconfig)
- [`DocumentScannerViewConfig`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscannerviewconfig)
- [`engineResourcePaths`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#engineresourcepaths)
- [`cameraEnhancerUIPath`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#cameraenhanceruipaths)

#### Modify the Build Script

Update the `scripts` section in `package.json` to automatically copy resources to the output `dist` directory during the build process.

```json
"scripts": {
"serve": "node dev-server/index.js",
"build": "rollup -c && npm run copy-libs",
"copy-libs": "npx mkdirp dist/libs && npx cpx \"node_modules/dynamsoft-*/**/*\" dist/libs/ --dereference",
"build:production": "rollup -c --environment BUILD:production"
},
```

#### Build the Project

Build the project by running:

```shell
npm run build
```

#### Serve the Project Locally

Start the local development server by running:

```shell
npm run serve
```

Once the server is running, open the application in a browser using the address provided in the terminal output.

#### Serve over HTTPS

**Place the `dist` directory** onto your web server to serve the web application. When deploying your web application for production, you must serve it over a **secure HTTPS connection**. We require this for the following reasons:

1. **Browser Security Restrictions** – Most browsers only allow access to camera video streams in a secure context.

> Some browsers like Chrome may grant access to camera video streams for `http://127.0.0.1`, `http://localhost`, or even pages opened directly from the local file system (`file:///...`). This can be helpful during development and testing.

2. **Dynamsoft License Requirements** – A secure context is required for **Dynamsoft licenses** to function properly.

#### Set MIME Type

Certain legacy web application servers may lack support for the `application/wasm` mimetype for .wasm files. To address this, you have two options:

1. Upgrade your web application server to one that supports the `application/wasm` mimetype.
2. Manually define the mimetype on your server by setting the MIME type for `.wasm` as `application/wasm`. This allows the user's browser to correctly process resource files. Different web servers have their own way of configuring the MIME type. Here are instructions for [Apache](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Apache_Configuration_htaccess#media_types_and_character_encodings), [IIS](https://docs.microsoft.com/en-us/iis/configuration/system.webserver/staticcontent/mimemap), and [NGINX](https://www.nginx.com/resources/wiki/start/topics/examples/full/#mime-types).

#### Resource Caching

The `wasm` resource files are relatively large and may take quite a few seconds to download. We recommend setting a longer cache time for these resource files to maximize the performance of your web application using the `Cache-Control` HTTP header. For example, use the `max-age` directive to cache resources for a specified time in seconds:

```
Cache-Control: max-age=31536000
```

Reference:
[`Cache-Control`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control)

## Hello World Sample Explained

Here we walk through the code in the Hello World sample to explain its function and usage.

> You can also view the full code by visiting the [MDS JS Hello World Sample on Github](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/hello-world.html).

### Reference MDS

```html

Mobile Document Scanner - Hello World

```

In this step, we reference MDS with a relative path to the local file in the `` section of the HTML.

```html

```

Alternatively, you can reference the script hosted on a CDN, for example, on JSDelivr:

```html

```

**MDS** wraps all its dependency scripts, so a **MDS** project only needs to include **MDS** itself as a single script. No additional dependency scripts are required.

> Even if you reference the script itself locally, MDS still defaults to loading supporting resources like `.wasm` engine files from the CDN at runtime. If you require a **fully offline setup**, follow the [quick start instructions to self-host resources](#quick-start).

### Instantiate MDS

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
});
```

API Reference: [`DocumentScanner()`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscanner)

This step creates the **MDS** UI, which by default occupies the entire visible area of the browser window when launched. If needed, you can restrict the UI to a specific container. For more details, refer to [Confine DocumentScanner UI to a Specific Container](#example-1-confine-documentscanner-ui-to-a-specific-container).

> Instantiating the `DocumentScanner` requires a valid license key.

### Launch MDS

```javascript
const result = await documentScanner.launch();
```

API Reference:

- [`launch()`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#launch)

This step launches the user into the document scanning workflow, beginning in the `DocumentScannerView`, where they can scan a document using one of three methods:

- Option 1: Manually scan by pressing the **shutter button**.
- Option 2: Enable "**Smart Capture**" - the scanner will automatically capture an image once a document is detected.
- Option 3: Enable "**Auto Crop**" - the scanner will automatically capture an image, detect the document, and crop it out of the video frame.

> For Options 1 & 2: The user is directed to `DocumentCorrectionView` to review detected document boundaries and make any necessary adjustments before applying corrections. Afterward, they proceed to `DocumentResultView`.
>
> For Option 3: The `DocumentCorrectionView` step is skipped. Image correction is applied automatically, and the user is taken directly to `DocumentResultView`.

In `DocumentResultView`, if needed, the user can return to `DocumentCorrectionView` to make additional adjustments or press "Re-take" to restart the scanning process.

### Display the Result

The workflow returns a scanned image object of type `CorrectedImageResult`. To display the scanned `result` image, we use a `

` in the ``:

```html

Mobile Document Scanner

```

API Reference:

- [`DocumentResult`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentresult)

The following code clears the result container and displays the scanned result as a canvas:

```javascript
if (result?.correctedImageResult) {
resultContainer.innerHTML = "";
const canvas = result.correctedImageResult.toCanvas();
resultContainer.appendChild(canvas);
} else {
resultContainer.innerHTML = "

No image scanned. Please try again.

";
}
```

## Custom Usage

This section builds on the Hello World sample to demonstrate how to configure **MDS**, typically by adjusting the `DocumentScannerConfig` object.

### `DocumentScannerConfig` Overview

[`DocumentScannerConfig`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscannerconfig) is the primary configuration object for customizing **MDS**. It includes the following properties:

1. `license` - the license key.
2. `container` - the HTML container for the entire workflow. If not specified (like in the Hello World Sample), one is created automatically.
3. `showCorrectionView` - toggle `DocumentCorrectionView` in the scanning workflow.
4. `showResultView` - toggle `DocumentResultView` in the scanning workflow.
5. `enableFrameVerification` - toggle selecting the clearest of multiple video frames upon scanning (on by default).
6. `enableContinuousScanning` - toggle continuous scanning mode to make multiple scans on a single `launch()` (`false` by default).
7. `onDocumentScanned` - handler to get single scan results in continuous scanning mode (if `enableContinuousScanning` is `true`).
8. `stopContinuousScanning` - programmatically stop the scanning loop when continuous scanning mode is enabled.
9. `scannerViewConfig` - configure the main scanner view with the following properties:
1. `container` - the HTML container for the `DocumentScannerView`.
2. `cameraEnhancerUIPath` - path to the UI definition file (.html) for the `DocumentScannerView`.
3. `enableAutoCropMode` - set the default value of Auto-Crop upon entering the `DocumentScannerView`.
4. `enableSmartCaptureMode` - set the default state of Smart Capture upon entering the `DocumentScannerView`.
5. `enableBoundsDetectionMode` - set the default state of bounds detection mode upon entering the `DocumentScannerView`.
6. `scanRegion` - set the scan region within the document scanning viewfinder.
7. `minVerifiedFramesForSmartCapture` - set the minimum number of video frames to verify detected document boundaries on Smart Capture mode. Higher frame counts lead to higher confidence at the cost of discarding results.
8. `showSubfooter` - toggle the visibility of the mode selector menu.
9. `showPoweredByDynamsoft` - set the visibility of the Dynamsoft branding message.
10. `correctionViewConfig` - configure the `DocumentCorrectionView`.
1. `container` - the HTML container for the `DocumentCorrectionView`.
2. `toolbarButtonsConfig` - configure the appearance and labels of the buttons for the `DocumentCorrectionView` UI.
3. `onFinish` - handler called when the user clicks the "Apply" button.
11. `resultViewConfig` - configure the result view with the following properties:
1. `container` - the HTML container for the `DocumentResultView`.
2. `toolbarButtonsConfig` - configure the appearance and labels of the buttons for the `DocumentResultView` UI.
3. `onDone` - handler called when the user clicks the "Done" button.
4. `onUpload` - handler called when the user clicks the "Upload" button.
12. `templateFilePath` - path to a Capture Vision template for scanning configuration; typically not needed as the default template is used.
13. `utilizedTemplateNames`- template names for detection and correction. Typically not needed as the default template is used.
14. `engineResourcePaths` - paths to extra resources such as `.wasm` engine files.

Furthermore, we explore three main (non-mutually-exclusive) avenues of customization with `DocumentScannerConfig`:

1. [**Multi-Page Scanning](#multi-page-scanning): through configuration objects and container definitions.
2. [**Workflow Customization**](#workflow-customization): through container definitions.
3. [**View-Based Customization**](#view-based-customization): through configuration objects.

The customization examples below build on the Hello World code from the [previous section](#use-precompiled-script). The only change required is adjusting the constructor argument.

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
// Add more arguments
});
```

### Multi-Page Scanning

Mobile Document Scanner can scan multi-page documents when configured to use the continuous scanning mode. Unlike the default behavior of returning a single scan on calling `launch()`, continuous scanning outputs a scan result on every successful scan, which you can further process by providing a handler. The workflow repeats to let the user scan through large documents efficiently.

See [**Workflow Customization**](#workflow-customization) and [**View-Based Customization**](#view-based-customization) for a more thorough explanation of the customization syntax.

#### Basic Multi-Page Scanning

[**Full Sample Source Code**](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/scenarios/multi-page-scanning.html)

The most straightforward way to implement multi-page scanning is to enable continuous scanning mode and provide a callback handler to process each scanned document via [`onDocumentScanned`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#ondocumentscanned). The scanner loops after each successful scan, allowing users to capture multiple pages in succession. The user can manually stop scanning by clicking the "Done" or close buttons from the Document Scanner View. Consider the relevant sections from the source code below:

```html

```

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE",
enableContinuousScanning: true,
onDocumentScanned: (result) => {
// Process each scanned document
const canvas = result.correctedImageResult.toCanvas();
document.getElementById("results").appendChild(canvas);
},
});

await documentScanner.launch();
```

API Reference:

- [`DocumentScannerConfig.enableContinuousScanning`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#enableContinuousScanning)
- [`DocumentScannerConfig.onDocumentScanned`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#ondocumentscanned)

##### Explanation

There are two essential components to multi-page scanning - enabling continuous scanning mode, and providing your handler to process the scanned pages.

1. We enable continuous scanning with the [`enableContinuousScanning`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#enableContinuousScanning) property - this is responsible for changing the user workflow, automatically going back to the scanner view to take more scans after confirming each scan.
2. We can then provide a handler to process the document pages to [`onDocumentScanned`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#ondocumentscanned). This handler gets called on confirming every scan. In this example, we simply display the result image to the page.

> [!NOTE]
> Just as in single-scan mode, `launch()` returns a `DocumentResult` promise. In continuous scanning mode, `launch()` returns a **`DocumentResult` promise to the last page scanned**.

##### Optional Settings

To enhance the scanning process, you may also choose to use the following settings:

1. Provide a handler to [`onThumbnailClicked`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#onthumbnailclicked), for example, to show a full preview of the last scanned page.
2. Stop the scanning loop programmatically by calling [`stopContinuousScanning()`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#stopcontinuousscanning) externally. This is particularly useful if scanning a pre-determined number of pages by counting the number of scans received by `onThumbnailClicked`.
3. For a faster scanning experience, enable both Smart Capture and Auto-Crop modes by default without requiring the user to re-enable them for each scan. See [Configure Scan Modes](#example-5-configure-scan-modes) for details.
4. Under certain use cases where the user does not need to manually edit or change the document boundaries, you can also skip the Document Correction and Document Result Views entirely. This allows the user to stay within the Document Scanner View to capture with the least number of manual interactions per scan. See [Only Show `DocumentScannerView`](#example-2-only-show-documentscannerview) for details.

#### Multi-Page Scanning with DDV

> [!TIP]
> You can find the full set of comprehensive documentation Dynamsoft Document Viewer [on our website](https://www.dynamsoft.com/document-viewer/docs/introduction/index.html).

[**Full Sample Source Code**](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/samples/scenarios/scanning-to-pdf.html)

For a more advanced multi-page scanning solution with document management, image editing, and comprehensive file support capabilities (including PDF), you can integrate **MDS** with **Dynamsoft Document Viewer (DDV)**. This combination provides:

- Document editing and management
- Thumbnail previews
- Page reordering and deletion
- PDF export functionality
- A polished UI for both mobile and desktop

Given the length of the sample, we only provide a snippet for creating the MDS instance here. See the full sample for more. Please see the [DDV documentation](https://www.dynamsoft.com/document-viewer/docs/introduction/index.html) for DDV-related APIs.

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
// Public trial license which is valid for 24 hours
// You can request a 30-day trial key from https://www.dynamsoft.com/customer/license/trialLicense/?product=mds
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
container: scannerContainer,
scannerViewConfig: {
enableAutoCropMode: true,
enableSmartCaptureMode: true,
},
enableContinuousScanning: true,
onDocumentScanned: async (result) => {
try {
// Convert the scanned image to blob
const canvas = result.correctedImageResult.toCanvas();
const blob = await new Promise((resolve) => {
canvas.toBlob((b) => resolve(b), "image/jpeg", 0.9);
});

// Add the scanned page to DDV document
if (blob) {
await doc.loadSource([
{
convertMode: "cm/auto",
fileData: blob,
},
]);
}
} catch (error) {
console.error("Error adding scanned page to DDV:", error);
}
},
});
```

API Reference:

- [`DocumentScannerViewConfig`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#documentscannerviewconfig)
- [`enableAutoCropMode`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#enableautocropmode)
- [`enableSmartCaptureMode`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#enablesmartcapturemode)
- [`DocumentScannerConfig.enableContinuousScanning`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#enableContinuousScanning)
- [`onDocumentScanned`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#ondocumentscanned)
- [`loadsource()`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/index.html#loadsource)

##### Explanation

For brevity, we outline the key steps in this sample implementation:

1. Initialize DDV
2. Customize the DDV edit viewer (notably by adding a scan button that launches MDS)
3. Instantiate the DDV edit viewer
4. Create a DDV document
5. Create a `DocumentScanner` instance
1. Enable continuous scanning
2. On confirming a scan, convert and send the image to the DDV document with [`loadsource()`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/index.html#loadsource) in the MDS event handler
6. Add an event to launch MDS from clicking the custom scan button added to ddv
7. Add an event to DDV that outputs a PDF of the scanned documents from DDV on close using [`saveToPdf()`](https://www.dynamsoft.com/document-viewer/docs/api/interface/idocument/#savetopdf)

### Workflow Customization

In the Hello World sample, we use the complete workflow with minimum configuration:

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
});
// Launch the scanner and wait for the result
const result = await documentScanner.launch();
```

In this case, **MDS** automatically creates container elements for its **Views**. In this section we discuss a few ways to adjust the **MDS** workflow.

#### Example 1: Confine DocumentScanner UI to a Specific Container

As long as the `DocumentScanner` container is assigned, **MDS** confines its **Views** within that container.

> Containers assigned to its constituent **Views** will be ignored.

```html

```

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
container: document.getElementById("myDocumentScannerContainer"), // Use this container for the full workflow
scannerViewConfig: {
container: document.getElementById("myDocumentScannerViewContainer"), // This container is ignored
},
});
```

API Reference:

#### Example 2: Only Show `DocumentScannerView`

If you do not need either the `DocumentResultView` or `DocumentCorrectionView` in your workflow (for example, if you do not want your user to manually alter the detected document boundaries), you can hide the views with the following configuration properties like so:

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
showResultView: false,
showCorrectionView: false,
});
```

API Reference:

#### Example 3: Specify Individual View Containers

If the configuration object provide containers for the `DocumentScannerView`, `DocumentResultView`, and `DocumentCorrectionView`, but **does not provide** the `DocumentScanner` container, then **MDS** renders the full workflow using these three containers.

```html

```

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
scannerViewConfig: {
container: document.getElementById("myDocumentScannerViewContainer"),
},
correctionViewConfig: {
container: document.getElementById("myDocumentCorrectionViewContainer"),
},
resultViewConfig: {
container: document.getElementById("myScanResultViewContainer"),
},
});
```

API Reference:

#### Example 4: Scan Static Image Directly

To scan an image file directly without displaying the `DocumentScannerView` UI at all, you can pass a `File` object to `launch()`. As an example, select an image file from the local disk:

```html

```

Then get the input file as a `File` object, and pass that file object to `launch()` MDS with:

```javascript
document.getElementById("initialFile").onchange = async function () {
const files = Array.from(this.files || []);
if (files.length) {
const result = await documentScanner.launch(files[0]);
console.log(result);

No image scanned. Please try again.

";
}
}
};
```

This hides the `DocumentScannerView` UI entirely and brings up the `DocumentCorrectionView` as the first view, after having detected document boundaries on the static image. The user can proceed through the rest of the workflow and further alter the document boundaries, re-take another image (to open up the `DocumentScannerView`), etc.

> `launch()` can accept images or PDFs. If launching with a PDF, MDS will **only process the first page**.

> You can completely disable all UI and use MDS to scan a file completely statically by hiding both the `DocumentCorrectionView` and the `DocumentResultView` in [example 2](#example-2-only-show-documentscannerview).

#### Example 5: Configure Scan Modes

The Document Scanner View comes with three scan modes:

1. Border Detection
2. Auto-Crop
3. Smart Capture

By default, Border Detection mode is enabled upon entering the Scanner View, while the other two are turned off by default. The user can then enable them by clicking their respective icons in the scanning mode sub-footer. From the `DocumentScannerViewConfig` interface, you can:

1. Set the default state of Auto-Crop mode with `enableAutoCropMode`
2. Set the default state of Smart Capture mode with `enableSmartCaptureMode`
3. Set the visibility of the scanning mode sub-footer with `showSubfooter`

> Border Detection Mode is always enabled upon the Scanner View, and the scanning sub-footer is visible by default.

For example, the following config enables all three scanning modes and hides the scanning mode sub-footer to prevent the viewer from changing or viewing the scanning modes:

API Reference:

### View-Based Customization

In addition to modifying the workflow, you can customize individual Views with configuration options for UI styling, button settings, and event handling.

#### `DocumentScannerView` Configuration

##### Customizing the `DocumentScannerView` UI

You can extensively customize the `DocumentScannerView` by editing its HTML template. Consider the following properties of the `DocumentScannerViewConfig` used for customizing the `DocumentScannerView`:

```typescript
interface DocumentScannerViewConfig {
container?: HTMLElement;
templateFilePath?: string;
cameraEnhancerUIPath?: string;
}
```

Of these three properties, we focus on `cameraEnhancerUIPath`. Here we omit `container`, as we cover it in [Workflow Customization](#workflow-customization), and we omit `templateFilePath`, as it refers to the DCV template file that configures document boundary detection algorithms.

> If the performance of **MDS** does not meet your needs, you may require an algorithm template **customized for your usage scenario** for better results. Please contact our experienced [Technical Support Team](https://www.dynamsoft.com/company/contact/) to discuss your requirements. We can tailor a suitable template for you, which you can then apply by updating `templateFilePath`.

`cameraEnhancerUIPath` points to a file hosted on the jsDelivr CDN by default (see [Self-Host Resources: Point to Resources](#point-to-resources)):
[https://cdn.jsdelivr.net/npm/dynamsoft-document-scanner@1.4.0/dist/document-scanner.ui.xml](https://cdn.jsdelivr.net/npm/dynamsoft-document-scanner@1.4.0/dist/document-scanner.ui.xml).

This file defines the UI for `DocumentScannerView`. Since files on the CDN **cannot be modified directly**, you must use a **local version** to customize the UI. `cameraEnhancerUIPath` specifies the file path to this local version of the UI.

##### Steps to Customize the UI for `DocumentScannerView`

1. Follow the instructions in [Build from Source](#build-from-source) to obtain the source files for **MDS**.

2. Edit the existing `/src/dcv-config/document-scanner.ui.xml` to apply your customizations.

3. Build the project to generate the updated file in `/dist/document-scanner.ui.xml`:

```shell
npm run build
```

4. Update the configuration to use the local file instead of the CDN version:

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace with your actual license key
scannerViewConfig: {
cameraEnhancerUIPath: "../dist/document-scanner.ui.xml", // Use the local file
},
});
```

API Reference:

##### Customizing the Scanning Region

We can customize the scanning region in the viewfinder with the `scanRegion` property in the configuration object. You may want to do this if you want to only scan your document in a specific sub-region in the viewfinder.

```typescript
interface ScanRegion {
ratio: {
width: number;
height: number;
};
regionBottomMargin: number; // Bottom margin calculated in pixel
style: {
strokeWidth: number;
strokeColor: string;
};
}
```

API Reference:

[`ScanRegion`](https://www.dynamsoft.com/mobile-document-scanner/docs/web/api/index.html#scanregion)

Here is how `ScanRegion` applies its settings to the viewfinder:

1. Use the `ratio` property to set the height-to-width of the rectangular scanning region, then scale the rectangle up to fit within the viewfinder.
2. Translate the rectangular up by the number of pixels specified by `regionBottomMargin`.
3. Create a visual border for the scanning region boundary on the viewfinder with a given stroke width in pixels, and a stroke color.

For example:

```javascript
scanRegion {
ratio: {
width: 2;
height: 3;
};
regionBottomMargin: 20;
style: {
strokeWidth: 3;
strokeColor: "green";
};
}
```

This creates a scan region with a height-to-width ratio of 3:2, translated upwards by 20 pixels, with a green, 3 pixel-wide border in the viewfinder.

#### `DocumentCorrectionView` Configuration

The following configuration interface customizes the `DocumentCorrectionView`:

```typescript
interface DocumentCorrectionViewConfig {
container?: HTMLElement;
toolbarButtonsConfig?: DocumentCorrectionViewToolbarButtonsConfig;
onFinish?: (result: DocumentScanResult) => void;
}
```

This section omits the `container` option, as we cover it in the [Workflow Customization](#workflow-customization) section. Below we discuss the other two properties.

##### Styling `DocumentCorrectionView` Buttons

The `toolbarButtonsConfig` property (of type `DocumentCorrectionViewToolbarButtonsConfig`) customizes the **appearance and functionality** of the UI buttons. Here is its definition:

```typescript
type ToolbarButtonConfig = Pick;
interface DocumentCorrectionViewToolbarButtonsConfig {
fullImage?: ToolbarButtonConfig;
detectBorders?: ToolbarButtonConfig;
apply?: ToolbarButtonConfig;
}
```

We can use it to **change the icon and label** of each of the three buttons individually or even **hide the buttons**. Below is an example that sets a custom label and image icon for the "Detect Borders" button and hides the "Full Image" button:

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
correctionViewConfig: {
toolbarButtonsConfig: {
fullImage: {
isHidden: true,
},
detectBorders: {
icon: "path/to/new_icon.png", // Change to the actual path of the new icon
label: "Custom Label",
},
},
},
});
```

API Reference:

##### Customizing Apply Button Callback

The `onFinish` callback triggers upon having applied the user's corrections. For example, the code below displays the corrected image in a `resultContainer` after the user clicks "Apply":

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
correctionViewConfig: {
onFinish: (result) => {
const canvas = result.correctedImageResult.toCanvas();
resultContainer.appendChild(canvas);
},
},
});
```

API Reference:

#### `DocumentResultView` Configuration

Consider `toolbarButtonsConfig`, `onDone` and `onUpload` from the `DocumentResultViewConfig` configuration interface to customize the `DocumentResultView`:

```typescript
interface DocumentResultViewConfig {
container?: HTMLElement;
toolbarButtonsConfig?: DocumentResultViewToolbarButtonsConfig;
onDone?: (result: DocumentResult) => Promise;
onUpload?: (result: DocumentResult) => Promise;
}
```

##### Styling `DocumentResultView` Buttons

The `toolbarButtonsConfig` property, of type `DocumentResultViewToolbarButtonsConfig`, customizes the appearance and functionality of the UI buttons. Here is its definition:

```typescript
type ToolbarButtonConfig = Pick;
interface DocumentResultViewToolbarButtonsConfig {
retake?: ToolbarButtonConfig;
correct?: ToolbarButtonConfig;
share?: ToolbarButtonConfig;
upload?: ToolbarButtonConfig;
done?: ToolbarButtonConfig;
}
```

This property can **change the icon and label** of each of the three buttons individually in the `DocumentResultView` or even **hide the buttons**. Below is an example that sets a custom label and image icon for the "Retake" button, and hides the "Share" button:

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
resultViewConfig: {
toolbarButtonsConfig: {
retake: {
icon: "path/to/new_icon.png", // Change to the actual path of the new icon
label: "Custom Label",
},
share: {
isHidden: true,
},
},
},
});
```

API Reference:

##### Customizing the "Done" Button Callback

The `onDone` callback triggers upon pressing the "Done" button. For example, the code below displays the result image in a `resultContainer` after the user clicks "Done":

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
resultViewConfig: {
onDone: async (result) => {
const canvas = result.correctedImageResult.toCanvas();
resultContainer.appendChild(canvas);
},
},
});
```

API Reference:

##### Customizing the "Upload" Button

The `onUpload` callback triggers upon pressing the "Upload" button. Note that the "Upload" button _only appears_ if a callback function is defined for `onUpload`; the button remains hidden otherwise.

The following example demonstrates how to upload the result image to a server:

> The following code applies if you follow the steps in [Build from Source](#build-from-source) and use the predefined express server setup. The scanned image uploads directly to the dev server as "uploadedFile.png". See the server configuration details in [`/dev-server/index.js`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/dev-server/index.js) for more details.

```javascript
const documentScanner = new Dynamsoft.DocumentScanner({
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
resultViewConfig: {
onUpload: async (result) => {
const host = window.location.origin;
const blob = await result.correctedImageResult.toBlob();
// Create form data
const formData = new FormData();
formData.append("uploadFile", blob, "uploadedFile.png");
// Upload file
const response = await fetch(
`${host}/upload`, // Change this to your actual upload URL
{
method: "POST",
body: formData,
}
);
},
},
});
```

API Reference:

## Next Step

**MDS** is a fully functional, ready-to-use scanning SDK with built-in UI layouts. For multi-page and **multi-document processing**, as well as advanced editing features, we developed **Mobile Web Capture (MWC)**. Read on to learn how to use this web-based wrapper SDK in the [**Mobile Web Capture User Guide**](https://www.dynamsoft.com/mobile-document-scanner/docs/web/code-gallery/mobile-web-capture/index.html).

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/dynamsoft/document-scanner-javascript

Awesome Lists containing this project

README

Mobile Document Scanner

Mobile Document Scanner