Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion _data/full_tree.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ tree_file_list:
- sidelist-introduction.html
- sidelist-guides.html
- sidelist-releasenotes.html
- sidelist-faq.html
- sidelist-full-tree.html
- sidelist-api-v1.1.html
- sidelist-codegallery-v1.1.html
- sidelist-introduction-v1.1.html
- sidelist-guides-v1.1.html
- sidelist-releasenotes-v1.1.html
- sidelist-full-tree-v1.1.html
- sidelist-full-tree-v1.1.html
2 changes: 2 additions & 0 deletions _includes/sidelist-faq.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<li><a href="/mrz-scanner/docs/web/faq/index.html" class="otherLinkColour">FAQ</a>
</li>
3 changes: 2 additions & 1 deletion _includes/sidelist-full-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-faq.html" -%}
30 changes: 30 additions & 0 deletions faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
layout: default-layout
needAutoGenerateSidebar: true
needGenerateH3Content: true
noTitleIndex: false
title: MRZ Scanner JavaScript Edition - FAQ
keywords: Documentation, MRZ Scanner JavaScript Edition, FAQ, Frequently Asked Questions
breadcrumbText: FAQ
description: MRZ Scanner JavaScript Edition Documentation Frequently Asked Questions
permalink: /faq/index.html
---

# Frequently Asked Questions

1. [Can the MRZ Scanner process static images, or does it only work with live cameras?](#can-the-mrz-scanner-process-static-images-or-does-it-only-work-with-live-cameras)
2. [Does MRZ Scanner perform data validation?](#does-the-mrz-scanner-perform-data-validation)
3. [How do I use the scanned result?](#how-do-i-use-the-scanned-result)

## Can the MRZ Scanner process static images, or does it only work with live cameras?

Yes, the MRZ Scanner can read from static images and image files, along with the typical use case of scanning from a live camera feed.

## Does the MRZ Scanner perform data validation?

**No**. MRZ Scanner JavaScript Edition performs all image capture, image enhancement, and MRZ parsing on-device, to give you full control of your data. The MRZ Scanner processes the data on the client device without passing the data to external servers. Your application must implement data validation on the decoded MRZ data after reading with the MRZ Scanner if your use case requires data validation.


## How do I use the scanned result?

The simplest implementation uses the default UI and does not take action after scanning. You can customize the behavior by handling callbacks provided by the API. The [`launch()`]({{ site.api }}mrz-scanner.html#launch) method returns the scanned result as the type [`MRZResult`]({{ site.api }}mrz-scanner.html#mrzresult), which includes the image of the document, as well as the parsed MRZ data separated into fields.
2 changes: 1 addition & 1 deletion guides/mrz-scanner-static-image.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ The first step in making the sample is to define the script references and the H
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft MRZ Scanner - Use File Input</title>
<!-- <script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@2.1.0/dist/mrz-scanner.bundle.js"></script> -->
<!-- <script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.1/dist/mrz-scanner.bundle.js"></script> -->
<!-- To use locally: -->
<script src="../../dist/mrz-scanner.bundle.js"></script>

Expand Down
14 changes: 7 additions & 7 deletions guides/mrz-scanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,21 +49,21 @@ The simplest way to include the SDK is to use either the [**jsDelivr**](https://
- jsDelivr

```html
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.1/dist/mrz-scanner.bundle.js"></script>
```

- UNPKG

```html
<script src="https://unpkg.com/dynamsoft-mrz-scanner@3.0.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://unpkg.com/dynamsoft-mrz-scanner@3.0.1/dist/mrz-scanner.bundle.js"></script>
```

When using a framework such as **React**, **Vue** or **Angular**, we recommend adding the package as a dependency using a package manager such as **npm** or **yarn**:

```sh
npm i dynamsoft-mrz-scanner@3.0.0 -E
npm i dynamsoft-mrz-scanner@3.0.1 -E
# or
yarn add dynamsoft-mrz-scanner@3.0.0 -E
yarn add dynamsoft-mrz-scanner@3.0.1 -E
```

> [!WARNING]
Expand All @@ -78,7 +78,7 @@ Below is the complete Hello World sample page that uses the precompiled script s
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft MRZ Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.1/dist/mrz-scanner.bundle.js"></script>
</head>

<body>
Expand Down Expand Up @@ -160,7 +160,7 @@ The first step is to get a copy of the resources. There are two ways which you c

- Go to the official [Github repository](https://github.com/Dynamsoft/mrz-scanner-javascript). Download the repository as a ZIP and the library resources are in the *dist* folder. So all you need is just a copy of this *dist* folder.

- If you are using `npm`, you could also install the package and extract the `dist` folder from the package in `node_modules`. Install the package using the command `npm i dynamsoft-mrz-scanner@3.0.0 -E`. Find the `dynamsoft-mrz-scanner` fodler in `node_modules` and the *dist* folder will be inside.
- If you are using `npm`, you could also install the package and extract the `dist` folder from the package in `node_modules`. Install the package using the command `npm i dynamsoft-mrz-scanner@3.0.1 -E`. Find the `dynamsoft-mrz-scanner` fodler in `node_modules` and the *dist* folder will be inside.

### Modify the Build Script

Expand Down Expand Up @@ -244,7 +244,7 @@ Let's now go through the code of the Hello World sample to understand how the co
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft MRZ Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.0/dist/mrz-scanner.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-mrz-scanner@3.0.1/dist/mrz-scanner.bundle.js"></script>
</head>

<body>
Expand Down
1 change: 1 addition & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ description: MRZ Scanner JavaScript Edition Documentation Homepage
- [Code Gallery]({{ site.codegallery }}index.html)
- [API Reference]({{ site.api }}index.html)
- [Release Notes]({{ site.releasenotes }}index.html)
- [FAQ](/mrz-scanner/docs/web/faq/index.html)
7 changes: 7 additions & 0 deletions releasenotes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@ permalink: /releasenotes/index.html

# Release Notes

## 3.0.1 (08/06/2025)

## Fixes

- Fixed the file input process error when decoding static file input when `showResultView` is set to `false`.
- Resolved an issue with the `launch()` method throwing an error when there's a different error format thrown.

## 3.0.0 (06/17/2025)

## Highlighted Features
Expand Down