Skip to content

Commit 041c4e5

Browse files
update to internal commit 1c1de721
1 parent 32b7233 commit 041c4e5

File tree

15 files changed

+154
-99
lines changed

15 files changed

+154
-99
lines changed

_data/product_version.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
useGroupedVersion: true
22

33
version_info_list_js:
4-
- value: latest version(10.5.1000)
4+
- value: latest version(10.5.3000)
55
- value: 10.x
66
child:
77
- 10.4.3100

assets/js/dbrWebVersionSearch.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[
22
{
3-
"version": "10.5.1000",
3+
"version": "10.5.3000",
44
"matchVersion": {
55
"javascript": "2.6.1000"
66
}

programming/javascript/api-reference/barcode-scanner.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ noTitleIndex: true
1111

1212
# Barcode Scanner JavaScript Edition API Reference
1313

14-
## Class: BarcodeScanner
14+
BarcodeScanner is a configurable barcode scanning module featuring a pre-built UI that supports both live camera and still image decoding. Designed for effortless integration into web applications, it offers a ready-to-use, customizable interface to streamline barcode scanning implementation.
1515

16-
A configurable barcode scanning module featuring a pre-built UI that supports both live camera and still image decoding. Designed for effortless integration into web applications, it offers a ready-to-use, customizable interface to streamline barcode scanning implementation.
16+
## Constructor
1717

18-
### Constructor
18+
### BarcodeScanner
1919

2020
```ts
2121
new BarcodeScanner(config?: BarcodeScannerConfig)
@@ -40,9 +40,9 @@ const barcodeScanner = new Dynamsoft.BarcodeScanner({
4040
});
4141
```
4242

43-
### Method
43+
## Methods
4444

45-
#### launch()
45+
### launch()
4646

4747
Launches the scanner and optionally renders the scanning UI based on scanMode and container configuration.
4848

@@ -68,7 +68,22 @@ A promise that resolves to a [`BarcodeScanResult`](#barcodescanresult).
6868
})();
6969
```
7070

71-
#### decode()
71+
### dispose()
72+
73+
Disposes the scanner instance and cleans up all related resources.
74+
75+
```ts
76+
dispose(): void
77+
```
78+
79+
**Code Snippet**
80+
81+
```js
82+
barcodeScanner.dispose();
83+
console.log("Scanner resources released.");
84+
```
85+
86+
### decode()
7287

7388
Decodes a barcode from an image, URL, or canvas element.
7489

@@ -94,21 +109,6 @@ const results = barcodeScanner.decode(imageUrl);
94109
//... do something with the results
95110
```
96111

97-
#### dispose()
98-
99-
Disposes the scanner instance and cleans up all related resources.
100-
101-
```ts
102-
dispose(): void
103-
```
104-
105-
**Code Snippet**
106-
107-
```js
108-
barcodeScanner.dispose();
109-
console.log("Scanner resources released.");
110-
```
111-
112112
## Interfaces
113113

114114
### BarcodeScannerConfig
@@ -123,7 +123,7 @@ interface BarcodeScannerConfig {
123123
utilizedTemplateNames?: UtilizedTemplateNames;
124124
engineResourcePaths?: EngineResourcePaths;
125125
uiPath?: string;
126-
barcodeFormats?: Array<EnumBarcodeFormat>;
126+
barcodeFormats?: EnumBarcodeFormat | Array<EnumBarcodeFormat>;
127127
duplicateForgetTime?: number;
128128
removePoweredByMessage?: boolean;
129129
container?: HTMLElement | string | undefined;
@@ -143,7 +143,7 @@ interface BarcodeScannerConfig {
143143
| `utilizedTemplateNames`(optional) | `UtilizedTemplateNames` | `{"single": "ReadSingleBarcode", "multi_unique": "ReadBarcodes_SpeedFirst", "image": "ReadBarcodes_ReadRateFirst"}` | Defines template names mapped to scanning modes. |
144144
| `engineResourcePaths`(optional) | `EngineResourcePaths` | `N/A` | Paths to engine resources like WASM or workers. See [EngineResourcePaths](https://www.dynamsoft.com/capture-vision/docs/web/programming/javascript/api-reference/core/core-module-class.html?product=dbr&lang=javascript#engineresourcepaths) for details. |
145145
| `uiPath` (optional) | `string` | `N/A` | Path to the custom UI (`.xml` template file) for the ScannerView.|
146-
| `barcodeFormats`(optional) | `Array<EnumBarcodeFormat>` | `N/A` | An array of [EnumBarcodeFormat](https://www.dynamsoft.com/capture-vision/docs/core/enums/barcode-reader/barcode-format.html?lang=js&product=dbr) specifying the formats to recognize. |
146+
| `barcodeFormats`(optional) | `EnumBarcodeFormat` \| `Array<EnumBarcodeFormat>` | `N/A` | [EnumBarcodeFormat](https://www.dynamsoft.com/capture-vision/docs/core/enums/barcode-reader/barcode-format.html?lang=js&product=dbr) or an array of `EnumBarcodeFormat` specifying the formats to recognize. |
147147
| `duplicateForgetTime`(optional) | `number` | `3000` | Time interval in milliseconds before duplicate barcodes can be reported again. |
148148
| `removePoweredByMessage`(optional) | `boolean` | `false` | Whether to remove the "powered by" message. |
149149
| `container`(optional) | `HTMLElement` \| `string` | `N/A` | A container element or selector for rendering the scanner and/or result view. |
@@ -168,7 +168,7 @@ interface BarcodeScannerConfig {
168168
// The path to your custom JSON template that defines the scanning process.
169169
templateFilePath:'./DBR-PresetTemplates.json',
170170
// engineResourcePaths typically is only assigned when using a framework like React/Angular/Vue where the resources are not in the same location as the script reference.
171-
engineResourcePaths: {rootDirectory:"https://cdn.jsdelivr.net/dynamsoft-barcode-reader-bundle@10.5.1000/dist"},
171+
engineResourcePaths: {rootDirectory:"https://cdn.jsdelivr.net/dynamsoft-barcode-reader-bundle@10.5.3000/dist"},
172172
barcodeFormats: [Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE , Dynamsoft.DBR.EnumBarcodeFormat.BF_CODE_128],
173173
removePoweredByMessage: true,
174174
duplicateForgetTime: 3000,
@@ -184,7 +184,7 @@ interface BarcodeScannerConfig {
184184
},
185185
resultViewConfig: {
186186
// the ResultViewConfig goes in here - see ResultViewConfig section
187-
},
187+
}
188188
};
189189
// Initialize the BarcodeScanner with the above BarcodeScannerConfig object
190190
const barcodeScanner = new Dynamsoft.BarcodeScanner(barcodeScannerConfig);
@@ -213,7 +213,7 @@ interface ScannerViewConfig {
213213
```js
214214
const barcodeScannerViewConfig = {
215215
showCloseButton: true // display the close button that shows up at the top right of the view
216-
}
216+
};
217217

218218
const barcodeScannerConfig = {
219219
license: "YOUR_LICENSE_KEY_HERE",
@@ -291,7 +291,7 @@ const barcodeScannerButtonConfig = {
291291
};
292292

293293
const barcodeResultViewConfig = {
294-
toolbarButtonsConfig: barcodeScannerButtonConfig,
294+
toolbarButtonsConfig: barcodeScannerButtonConfig
295295
};
296296
```
297297

@@ -361,7 +361,7 @@ ResultStatus is used to represent the status of the barcode scanning result. Thi
361361
```ts
362362
type ResultStatus = {
363363
code: EnumResultStatus;
364-
message?: string;
364+
message: string;
365365
}
366366
```
367367

programming/javascript/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ To get a fast start, you can
2323

2424
The following describes the highlights of DBR JavaScript edition (DBR-JS) version 10.x.
2525

26-
## New in v10.5.1000: BarcodeScanner – Simplified API and Built-in UI
26+
## New in v10.5.3000: BarcodeScanner – Simplified API and Built-in UI
2727

28-
Version 10.5.1000 introduces the all-new `BarcodeScanner` class, offering a streamlined API and a prebuilt interactive UI, making barcode scanning integration easier than ever. This is now the recommended way to use DBR-JS, especially for developers who want a quick, clean, and robust scanning experience with minimal setup.
28+
Version 10.5.3000 introduces the all-new `BarcodeScanner` class, offering a streamlined API and a prebuilt interactive UI, making barcode scanning integration easier than ever. This is now the recommended way to use DBR-JS, especially for developers who want a quick, clean, and robust scanning experience with minimal setup.
2929

3030
With `BarcodeScanner`, you can:
3131

programming/javascript/release-notes/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ permalink: /programming/javascript/release-notes/index.html
1010

1111
# DBR JavaScript SDK - Release Notes
1212

13+
- [10.5.3000 (04/24/2025)](js-10.html#1053000-04242025)
1314
- [10.4.3100 (01/03/2025)](js-10.html#1043100-01032025)
1415
- [10.4.2002 (10/24/2024)](js-10.html#1042002-10242024)
1516
- [10.2.10 (04/03/2024)](js-10.html#10210-04032024)

programming/javascript/release-notes/js-10.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,23 @@ permalink: /programming/javascript/release-notes/js-10.html
1111

1212
# Release Notes for Dynamsoft Barcode Reader JavaScript SDK
1313

14+
## 10.5.3000 (04/24/2025)
15+
16+
### New
17+
18+
- Introduced [BarcodeScanner](https://dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/barcode-scanner.html) class
19+
- Offers high-level APIs that provide core functionalities
20+
- Includes pre-built UI for fast and seamless integration
21+
- Features intuitive configuration objects to simplify both algorithm and UI setup
22+
23+
<p align="center">
24+
<img src="../user-guide/assets/barcodeScanner_single_mode.png" alt="multiple" width="35%" style="margin-right: 50px;"/>
25+
<img src="../user-guide/assets/barcodeScanner_multiple_mode.png" alt="multiple" width="35%"/>
26+
</p>
27+
28+
### Improved
29+
30+
- Merged resource files previously required by the Barcode-Reader-Bundle, significantly reduced the overall size of the `.wasm` file
1431

1532
## 10.4.3100 (01/03/2025)
1633

programming/javascript/upgrade-guide/9to10.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ In version 10.x, you may need to reference several modules:
4848
In version 10.0.21 and above, you can also just use this line for simplicity:
4949

5050
```html
51-
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.1000/dist/dbr.bundle.js"></script>
51+
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
5252
```
5353

5454
## Change the APIs for initializing
296 KB
Loading
444 KB
Loading
65.9 KB
Loading

0 commit comments

Comments
 (0)