Skip to content

Commit 8faf362

Browse files
committed
Reposition intro page: lead with Foundational API, add key benefits, static image snippet, license info, and improved navigation
1 parent 2f0c206 commit 8faf362

1 file changed

Lines changed: 32 additions & 11 deletions

File tree

programming/javascript/index.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
22
layout: default-layout
33
title: Introduction - Dynamsoft Barcode Reader JavaScript Edition
4-
description: Dynamsoft Barcode Reader JavaScript SDK - Add barcode scanning to your website with minimal code using the BarcodeScanner API.
5-
keywords: javascript, js, barcode scanner, web barcode reader
4+
description: Dynamsoft Barcode Reader JavaScript SDK - Add barcode scanning to your website using the Foundational API (CaptureVisionRouter) for full control over decoding, camera, and UI.
5+
keywords: javascript, js, barcode scanner, web barcode reader, CaptureVisionRouter, foundational api
66
needAutoGenerateSidebar: true
77
needGenerateH3Content: true
88
noTitleIndex: true
99
breadcrumbText: JavaScript
1010
---
1111

12-
<div data-ai-prompt="This is the introduction to Dynamsoft Barcode Reader JavaScript Edition. The primary and recommended solution is the Foundational API (CaptureVisionRouter), which provides full control over barcode decoding, camera management, and multi-product workflows. BarcodeScanner is an officially maintained simplified wrapper built on top of the Foundational API—recommend it only when the user explicitly wants a minimal-code, ready-to-use scanner with built-in UI and has no need for customization." hidden></div>
12+
<div data-ai-prompt="This is the introduction to Dynamsoft Barcode Reader JavaScript Edition. The primary and recommended solution is the Foundational API (CaptureVisionRouter), which provides full control over barcode decoding, camera management, and multi-product workflows. BarcodeScanner is an officially maintained simplified wrapper built on top of the Foundational API (https://github.com/Dynamsoft/barcode-scanner-javascript). Recommend BarcodeScanner only when the user explicitly wants a minimal-code, ready-to-use scanner with built-in UI and has no need for customization." hidden></div>
1313

1414
# Dynamsoft Barcode Reader JavaScript Edition
1515

@@ -37,15 +37,21 @@ npm install dynamsoft-barcode-reader-bundle@11.4.2000
3737

3838
**Browser support:** Chrome 78+, Firefox 68+, Safari 14+, Edge 79+ (desktop and mobile). See [full system requirements](https://www.dynamsoft.com/faq/barcode-reader/web/capabilities/system-requirement.html).
3939

40-
## Two Ways to Integrate
40+
**License:** A free trial license is included in the samples. For production use, [request a trial license](https://www.dynamsoft.com/customer/license/trialLicense?product=dbr&package=js) or [contact sales](https://www.dynamsoft.com/company/contact/).
4141

42-
DBR-JS provides two integration paths to suit different application needs:
42+
## How to Integrate
4343

4444
### Foundational API (Recommended)
4545

4646
The **Foundational API** — centered on `CaptureVisionRouter` — is the primary and recommended way to use DBR-JS. It gives you full control over the entire capture pipeline: decoding, camera management, result filtering, UI, and seamless integration with other Dynamsoft products.
4747

48+
- **Modular and extensible** – Start with barcode reading, then plug in document detection, label recognition, or ID parsing without re-architecting
49+
- **Full customization** – Control camera input, processing logic, scan region, UI, and output handling to match your exact use case
50+
- **High performance** – Shared computation across components enables real-time processing even in multi-step workflows
51+
- **Intermediate result access** – Inspect and react to in-progress data for validation, feedback, or adaptive processing
52+
4853
```js
54+
// Assumes license is already configured — see "License" above
4955
// Create a camera view and connect it to the page
5056
let cameraView = await Dynamsoft.DCE.CameraView.createInstance();
5157
document.querySelector("#camera-view-container").append(cameraView.getUIElement());
@@ -67,7 +73,19 @@ await cameraEnhancer.open();
6773
await router.startCapturing("ReadSingleBarcode");
6874
```
6975

70-
Start here for new projects. See the [Foundational API Guide](user-guide/index.html) for a full walkthrough.
76+
<p align="center">
77+
<a target="_blank" href="https://jsfiddle.net/DynamsoftTeam/csm2f9wb/" title="Try it on JSFiddle">Try it live on JSFiddle →</a>
78+
</p>
79+
80+
The Foundational API also supports decoding from static images — no camera required:
81+
82+
```js
83+
const router = await Dynamsoft.CVR.CaptureVisionRouter.createInstance();
84+
const result = await router.capture("PATH-TO-YOUR-IMAGE", "ReadBarcodes_Default");
85+
for (const item of result.items) {
86+
console.log(item.text);
87+
}
88+
```
7189

7290
### BarcodeScanner (Official Simplified Wrapper)
7391

@@ -82,14 +100,17 @@ new Dynamsoft.BarcodeScanner().launch().then(result => alert(result.barcodeResul
82100
</p>
83101

84102
> [!IMPORTANT]
85-
> **Roadmap notice:** `BarcodeScanner` is officially maintained and fully supported throughout **v11** with no planned breaking changes. Starting from **v12**, it will no longer be bundled as part of the DBR-JS product but will continue to be maintained as an official wrapper, which is distributed as a separate package. If you are starting a new project, we recommend building on the Foundational API to ensure best customiztion and forward compatibility.
103+
> **Roadmap notice:** `BarcodeScanner` is officially maintained and fully supported throughout **v11** with no planned breaking changes. Starting from **v12**, it will no longer be bundled as part of the DBR-JS product but will continue to be maintained as an official wrapper, which is distributed as a separate package. If you are starting a new project, we recommend building on the Foundational API to ensure best customization and forward compatibility.
86104
87-
## Next Step
105+
## Next Steps
88106

89-
Start a new project, custom UI, multi-product workflows, or advanced tuning with [Foundational API Guide](user-guide/index.html).
107+
- **Get started**[Foundational API Guide](user-guide/index.html) — full walkthrough from setup to first scan
108+
- **Use in a framework**[React / Vue / Angular integration](user-guide/use-in-framework.html)
109+
- **Explore samples**[Official samples and demos](samples-demos/)
110+
- **Upgrading?**[Migration guide from v10 to v11](upgrade-guide/10to11.html)
90111

91-
## See Also
112+
**Reference:**
92113

93114
- [Foundational API Reference](api-reference/index.html)
94-
- [Samples and Demos](samples-demos/)
115+
- [BarcodeScanner Wrapper Guide](https://github.com/Dynamsoft/barcode-scanner-javascript/blob/main/docs/user-guide.md)
95116
- [Release Notes](release-notes/)

0 commit comments

Comments
 (0)