Skip to content
This repository was archived by the owner on Apr 25, 2025. It is now read-only.

Commit 6b1c321

Browse files
2.2.31
1 parent 6952600 commit 6b1c321

File tree

12 files changed

+56
-54
lines changed

12 files changed

+56
-54
lines changed

Api Reference.url

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
[InternetShortcut]
2-
URL=https://www.dynamsoft.com/label-recognition/programming/javascript/?ver=latest
2+
URL=https://www.dynamsoft.com/label-recognition/programming/javascript/?ver=2.2.31

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
<!--The original doc is hosted here => https://github.com/dynamsoft-docs/label-recognition-docs/blob/master/programming/javascript/user-guide.md -->
21
# Dynamsoft Label Recognizer for Your Website
32

43
Add the capability of reading passport MRZs, ID cards, VIN numbers, and various other fixed text fields in your web application with just a few lines of code.
@@ -43,8 +42,8 @@ The complete code of the "MRZ Reading" example is shown below
4342

4443
<head>
4544
<title>MRZ Reading</title>
46-
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/dlr.js"></script>
47-
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.2.0/dist/dce.js"></script>
45+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.31/dist/dlr.js"></script>
46+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.3.5/dist/dce.js"></script>
4847
</head>
4948

5049
<body>
@@ -173,15 +172,15 @@ The simplest way to include the SDK is to use either the [jsDelivr](https://jsde
173172
* jsDelivr
174173

175174
```html
176-
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/dlr.js"></script>
177-
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.2.0/dist/dce.js"></script>
175+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.31/dist/dlr.js"></script>
176+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.3.5/dist/dce.js"></script>
178177
```
179178

180179
* UNPKG
181180

182181
```html
183-
<script src="https://unpkg.com/dynamsoft-label-recognizer@2.2.30/dist/dlr.js"></script>
184-
<script src="https://unpkg.com/dynamsoft-camera-enhancer@3.2.0/dist/dce.js"></script>
182+
<script src="https://unpkg.com/dynamsoft-label-recognizer@2.2.31/dist/dlr.js"></script>
183+
<script src="https://unpkg.com/dynamsoft-camera-enhancer@3.3.5/dist/dce.js"></script>
185184
```
186185

187186
#### Host the SDK yourself
@@ -193,22 +192,22 @@ To download the SDK:
193192
* yarn
194193

195194
```cmd
196-
yarn add dynamsoft-label-recognizer@2.2.30
197-
yarn add dynamsoft-camera-enhancer@3.2.0
195+
yarn add dynamsoft-label-recognizer@2.2.31
196+
yarn add dynamsoft-camera-enhancer@3.3.5
198197
```
199198

200199
* npm
201200

202201
```cmd
203-
npm install dynamsoft-label-recognizer@2.2.30
204-
npm install dynamsoft-camera-enhancer@3.2.0
202+
npm install dynamsoft-label-recognizer@2.2.31
203+
npm install dynamsoft-camera-enhancer@3.3.5
205204
```
206205

207206
Depending on how you downloaded the SDK and where you put it, you can typically include it like this:
208207

209208
```html
210-
<script src="/dynamsoft-label-recognizer-js-2.2.30/dist/dlr.js"></script>
211-
<script src="/dynamsoft-label-recognizer-js-2.2.30/dce/dist/dce.js"></script>
209+
<script src="/dynamsoft-label-recognizer-js-2.2.31/dist/dlr.js"></script>
210+
<script src="/dynamsoft-label-recognizer-js-2.2.31/dce/dist/dce.js"></script>
212211
```
213212

214213
or
@@ -245,8 +244,8 @@ If the engine files (\*.worker.js, \*.wasm.js and \*.wasm, etc.) are not in the
245244

246245
```javascript
247246
// The following code uses the jsDelivr CDN, feel free to change it to your own location of these files.
248-
Dynamsoft.DLR.LabelRecognizer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/";
249-
Dynamsoft.DCE.CameraEnhancer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.2.0/dist/";
247+
Dynamsoft.DLR.LabelRecognizer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.31/dist/";
248+
Dynamsoft.DCE.CameraEnhancer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-camera-enhancer@3.3.5/dist/";
250249
```
251250

252251
**This configuration is usually required with frameworks like Angular or React where dlr.js is compiled into another file.**
@@ -301,7 +300,7 @@ await recognizer.setImageSource(cameraEnhancer, options);
301300

302301
#### Change the camera settings if necessary
303302

304-
In some cases, a different camera might be required instead of the default one. Also, a different resolution might work better. To change the camera or the resolution, we use the `CameraEnhancer` object. Learn more [here](https://www.dynamsoft.com/camera-enhancer/docs/programming/javascript/api-reference/camera-control.html?ver=3.2.0&utm_source=github&product=dlr&package=js).
303+
In some cases, a different camera might be required instead of the default one. Also, a different resolution might work better. To change the camera or the resolution, we use the `CameraEnhancer` object. Learn more [here](https://www.dynamsoft.com/camera-enhancer/docs/programming/javascript/api-reference/camera-control.html?ver=3.3.5&utm_source=github&product=dlr&package=js).
305304

306305
```javascript
307306
// The following lines set which camera and what resolution to use.
@@ -450,7 +449,7 @@ await recognizer.startScanning(true);
450449
## API Documentation
451450

452451
You can check out the detailed documentation about the APIs of the SDK at
453-
[https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=2.2.30&utm_source=github&product=dlr&package=js](https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=2.2.30&utm_source=github&product=dlr&package=js).
452+
[https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=2.2.31&utm_source=github&product=dlr&package=js](https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=2.2.31&utm_source=github&product=dlr&package=js).
454453

455454
## System Requirements
456455

@@ -484,13 +483,13 @@ The following table is a list of supported browsers based on the above requireme
484483
Chrome | v61+<sup>1</sup>
485484
Firefox | v52+ (v55+ on Android/iOS<sup>1</sup>)
486485
Edge<sup>2</sup> | v16+
487-
Safari<sup>3</sup> | v11+
486+
Safari | v13+
488487

489488
<sup>1</sup> iOS 14.3+ is required for camera video streaming in Chrome and Firefox or Apps using webviews.
490489

491490
<sup>2</sup> On Edge, due to strict Same-origin policy, you must host the SDK files on the same domain as your web page.
492-
493-
<sup>3</sup> Safari v11.x already has the required features, but it has many other issues, so we recommend v12+.
491+
492+
> Note: iOS 12 is currently not compatible with Dynamsoft Label Recognizer v 2.2.30+, due to certain technical limitations.
494493
495494
Apart from the browsers, the operating systems may impose some limitations of their own that could restrict the use of the SDK. Browser compatibility ultimately depends on whether the browser on that particular operating system supports the features listed above.
496495

@@ -504,4 +503,4 @@ Now that you have got the SDK integrated, you can choose to move forward in the
504503

505504
1. Check out the [official samples](https://github.com/Dynamsoft/label-recognizer-javascript-samples).
506505
2. Check out the official demos: [MRZ Scanner](https://demo.dynamsoft.com/label-recognizer-js/mrz-scanner.html), [VIN Scanner](https://demo.dynamsoft.com/label-recognizer-js/vin.html) and the [source code for the demo](https://github.com/Dynamsoft/label-recognizer-javascript-demo).
507-
3. Learn about the available [APIs](https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=latest).
506+
3. Learn about the available [APIs](https://www.dynamsoft.com/label-recognition/docs/programming/javascript/api-reference/?ver=latest).

dist/dlr-2.2.30.browser.worker.js

Lines changed: 0 additions & 11 deletions
This file was deleted.

dist/dlr-2.2.31.browser.worker.js

Lines changed: 11 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/dlr.esm.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/dlr.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/dlr.mjs

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dist/types/class/labelrecognizer.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export default class LabelRecognizer {
4343
* ```
4444
* For convenience, you can set `license` in `script` tag instead.
4545
* ```html
46-
* <script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/dlr.js" data-license="LICENSE"></script>
46+
* <script src="https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer/dist/dlr.js" data-license="LICENSE"></script>
4747
* ```
4848
*/
4949
static get license(): string;
@@ -81,7 +81,7 @@ export default class LabelRecognizer {
8181
* The SDK will try to automatically explore the engine location.
8282
* If the auto-explored engine location is not accurate, manually specify the engine location.
8383
* ```js
84-
* Dynamsoft.DLR.LabelRecognizer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/";
84+
* Dynamsoft.DLR.LabelRecognizer.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer/dist/";
8585
* await Dynamsoft.DLR.LabelRecognizer.loadWasm();
8686
* ```
8787
*/
@@ -210,7 +210,7 @@ export default class LabelRecognizer {
210210
* The url of the default scanner UI.
211211
* Can only be changed before `createInstance`.
212212
* ```js
213-
* Dynamsoft.DLR.LabelRecognizer.defaultUIElementURL = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer@2.2.30/dist/dlr.ui.html";
213+
* Dynamsoft.DLR.LabelRecognizer.defaultUIElementURL = "https://cdn.jsdelivr.net/npm/dynamsoft-label-recognizer/dist/dlr.ui.html";
214214
* let pScanner = null;
215215
* (async()=>{
216216
* let scanner = await (pScanner = pScanner || Dynamsoft.DLR.LabelRecognizer.createInstance());

0 commit comments

Comments
 (0)