Gathering detailed insights and metrics for dynamsoft-javascript-barcode
Gathering detailed insights and metrics for dynamsoft-javascript-barcode
Dynamsoft Barcode Reader JavaScript SDK for package managers. PDF417, QR Code, DataMatrix, MaxiCode and more are supported.
9.6.42
178
NOASSERTION
17.80 MB
Installations
npm install dynamsoft-javascript-barcodeDeveloper Guide
BETA
Typescript
Yes
Module System
ESM
Node Version
12.22.12
NPM Version
6.14.16
Developer
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
NOASSERTION License
178 Stars
113 Commits
108 Forks
12 Watchers
9 Branches
10 Contributors
Updated on Jul 10, 2025
Maintainers
5
Package Meta Information
Latest Version
9.6.42
Package Id
dynamsoft-javascript-barcode@9.6.42
Unpacked Size
17.80 MB
Size
6.24 MB
File Count
24
NPM Version
6.14.16
Node Version
12.22.12
Published on
Apr 26, 2024
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Barcode Reader for Your Website - User Guide
Dynamsoft Barcode Reader JavaScript Edition (DBR-JS) is equipped with industry-leading algorithms for exceptional speed, accuracy and read rates in barcode reading. Using its well-designed API, you can turn your web page into a barcode scanner with just a few lines of code.
Once the DBR-JS SDK gets integrated into your web page, your users can access a camera via the browser and read barcodes directly from its video input.
In this guide, you will learn step by step on how to integrate the DBR-JS SDK into your website.
Table of Contents
- Hello World - Simplest Implementation
- Building your own page
- API Documentation
- System Requirements
- How to Upgrade
- Release Notes
- Next Steps
Popular Examples
- Hello World - Guide | Github
- Angular App - Guide | Github
- React App - Guide | Github
- Vue App - Guide | Github
- PWA App - Guide | Github
- WebView in Android and iOS - Github
- Read Driver Licenses - Guide | Github
- Fill A Form - Guide | Github
- Show result information on the video - Github
- Debug Camera and Collect Video Frame - Guide | Github
You can also:
Hello World - Simplest Implementation
Let's start with the "Hello World" example of the DBR-JS SDK which demonstrates how to use the minimum code to enable a web page to read barcodes from a live video stream.
- Basic Requirements
- Internet connection
- A supported browser
- Camera access
Understand the code
The complete code of the "Hello World" example is shown below
1<!DOCTYPE html> 2<html> 3 4<body> 5 <script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@9.6.42/dist/dbr.js"></script> 6 <script> 7 // Specifies a license, you can visit https://www.dynamsoft.com/customer/license/trialLicense?ver=9.6.42&utm_source=npm&product=dbr&package=js to get your own trial license good for 30 days. 8 Dynamsoft.DBR.BarcodeScanner.license = 'DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9'; 9 // Initializes and uses the SDK 10 (async () => { 11 let scanner = await Dynamsoft.DBR.BarcodeScanner.createInstance(); 12 scanner.onFrameRead = results => { 13 if (results.length > 0) console.log(results); 14 }; 15 scanner.onUniqueRead = (txt, result) => { 16 alert(txt); 17 }; 18 await scanner.show(); 19 })(); 20 </script> 21</body> 22 23</html>
About the code
- The DBR-JS SDK is included in the code via the jsDelivr CDN.
In some rare cases, you might not be able to access the CDN. If this happens, you can use https://download2.dynamsoft.com/dbr/dynamsoft-barcode-reader-js/dynamsoft-barcode-reader-js-9.6.42/dist/dbr.js for the test. However, please DO NOT use CDN of
download2.dynamsoft.comin your production application because it is temporary. Instead, you can try hosting the SDK yourself.
-
license: This property specifies a license key. Note that the license "DLS2eyJvcmdhbml6YXRpb25JRCI6IjIwMDAwMSJ9" used in this example is an online license and requires network connection to work. Read more on Specify the license. -
createInstance(): This method creates aBarcodeScannerobject. This object can read barcodes directly from a video input with the help of its interactive UI (hidden by default) and the MediaDevices interface. -
onFrameRead: This event is triggered every time the SDK finishes scanning a video frame. Theresultsobject contains all the barcode results that the SDK have found on this frame. In this example, we print the results to the browser console. -
onUniqueRead: This event is triggered when the SDK finds a new barcode, which is not a duplicate among multiple frames.txtholds the barcode text value whileresultis an object that holds details of the barcode. In this example, an alert will be displayed for this new barcode. -
show(): This method brings up the built-in UI of theBarcodeScannerobject and starts scanning.
Run the example
You can run the example deployed to the Dynamsoft Demo Server or test it with JSFiddle code editor. You will be asked to allow access to your camera, after which the video will be displayed on the page. After that, you can point the camera at a barcode to read it.
When a barcode is decoded, you will see the result text pop up and the barcode location will be highlighted in the video feed.
Alternatively, you can make a local test simply by taking the code in step 1, pasting it in a file with the name "hello-world.html" and open it in a browser.
Note:
If you open the web page as file:/// or http:// , the camera may not work correctly because the API getUserMedia usually requires HTTPS to access the camera.
To make sure your web application can access the camera, please configure your web server to support HTTPS. The following links may help.
- NGINX: Configuring HTTPS servers
- IIS: Create a Self Signed Certificate in IIS
- Tomcat: Setting Up SSL on Tomcat in 5 minutes
- Node.js: npm tls
If the test doesn't go as expected, you can contact us.
Building your own page
Include the SDK
Use a public CDN
The simplest way to include the SDK is to use either the jsDelivr or UNPKG CDN. The "hello world" example above uses jsDelivr.
-
jsDelivr
1<script src="https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@9.6.42/dist/dbr.js"></script> -
UNPKG
1<script src="https://unpkg.com/dynamsoft-javascript-barcode@9.6.42/dist/dbr.js"></script>
Host the SDK yourself
Besides using the public CDN, you can also download the SDK and host its files on your own server or a commercial CDN before including it in your application.
Options to download the SDK:
-
From the website
-
yarn
1yarn add dynamsoft-javascript-barcode -
npm
1npm install dynamsoft-javascript-barcode --save
Depending on how you downloaded the SDK and how you intend to use it, you can typically include it like this:
1<script src="/dynamsoft-barcode-reader-js-9.6.42/dist/dbr.js"></script>
or
1<script src="/node_modules/dynamsoft-javascript-barcode/dist/dbr.js"></script>
or
1import { BarcodeScanner } from 'dynamsoft-javascript-barcode';
NOTE
-
Some older web application servers do not set
.wasmmimetype asapplication/wasm. Upgrade your web application servers, or define the mimetype yourselves: -
To work properly, the SDK requires a few engine files, which are relatively large and may take quite a few seconds to download. We recommend that you set a longer cache time for these engine files, to maximize the performance of your web application.
1Cache-Control: max-age=31536000Reference: Cache-Control.
Configure the SDK
Before using the SDK, you need to configure a few things.
Specify the license
The SDK requires a license to work, use the API license to specify a license key.
1Dynamsoft.DBR.BarcodeScanner.license = "YOUR-LICENSE-KEY";
To test the SDK, you can request a 30-day trial license via the customer portal.
If you register a Dynamsoft account and download the SDK from the official website, Dynamsoft will automatically generate a 30-day trial license for you, and put the license key into all the samples attached to the SDK.
Specify the location of the "engine" files
This is usually only required with frameworks like Angular or React, etc. where dbr.js is compiled into another file.
The purpose is to tell the SDK where to find the engine files (*.worker.js, *.wasm.js and *.wasm, etc.). The API is called engineResourcePath:
1//The following code uses the jsDelivr CDN, feel free to change it to your own location of these files 2Dynamsoft.DBR.BarcodeScanner.engineResourcePath = "https://cdn.jsdelivr.net/npm/dynamsoft-javascript-barcode@9.6.42/dist/";
Interact with the SDK
Create a BarcodeScanner object
You can use one of two classes ( BarcodeScanner and BarcodeReader ) to interact with the SDK. BarcodeReader is a low-level class that processes images directly. BarcodeScanner , on the other hand, inherits from BarcodeReader and provides high-level APIs and a built-in GUI to allow continuous barcode scanning on video frames. We'll focus on BarcodeScanner in this guide.
To use the SDK, we first create a BarcodeScanner object.
1Dynamsoft.DBR.BarcodeScanner.license = "YOUR-LICENSE-KEY"; 2let scanner = null; 3try { 4 scanner = await Dynamsoft.DBR.BarcodeScanner.createInstance(); 5} catch (ex) { 6 console.error(ex); 7}
Tip: When creating a BarcodeScanner object within a function which may be called more than once, it's best to use a "helper" variable to avoid double creation such as pScanner in the following code
1Dynamsoft.DBR.BarcodeScanner.license = "YOUR-LICENSE-KEY"; 2let pScanner = null; 3document.getElementById('btn-scan').addEventListener('click', async () => { 4 try { 5 const scanner = await (pScanner = pScanner || Dynamsoft.DBR.BarcodeScanner.createInstance()); 6 } catch (ex) { 7 console.error(ex); 8 } 9});
Customize the BarcodeScanner Settings (optional)
Let's take a look at the following code snippets:
1// Sets which camera and what resolution to use 2let allCameras = await scanner.getAllCameras(); 3await scanner.setCurrentCamera(allCameras[0].deviceId); 4await scanner.setResolution(1280, 720);
1// Sets up the scanner behavior 2let scanSettings = await scanner.getScanSettings(); 3// Disregards duplicated results found in a specified time period (in milliseconds). 4scanSettings.duplicateForgetTime = 5000; // The default is 3000 5// Sets a scan interval in milliseconds so the SDK may release the CPU from time to time. 6// (setting this value larger is a simple way to save battery power and reduce device heating). 7scanSettings.intervalTime = 100; // The default is 0. 8// Sets captureAndDecodeInParallel to false, which tells the SDK not to acquire the next frame while decoding the first. 9// This is another way to save battery power and is recommended on low-end phones. However, it does slow down the decoding speed. 10scanSettings.captureAndDecodeInParallel = false; // The default is true. 11await scanner.updateScanSettings(scanSettings);
1// Uses one of the built-in RuntimeSetting templates: "single" (decode a single barcode, the default mode), "speed", "balance", "coverage", "dense" and "distance" 2await scanner.updateRuntimeSettings("speed"); 3 4// Makes changes to the template. The code below demonstrates how to specify enabled symbologies 5let runtimeSettings = await scanner.getRuntimeSettings(); 6runtimeSettings.barcodeFormatIds = Dynamsoft.DBR.EnumBarcodeFormat.BF_ONED | Dynamsoft.DBR.EnumBarcodeFormat.BF_QR_CODE; 7await scanner.updateRuntimeSettings(runtimeSettings);
As you can see from the above code snippets, there are three types of configurations:
-
Customize the data source: This configuration includes which camera to use, the preferred resolution, etc. Learn more here.
-
get/updateScanSettings: Configures the behavior of the scanner which includesduplicateForgetTimeandintervalTime, etc. -
get/updateRuntimeSettings: Configures the decode engine with either a built-in template or a comprehensiveRuntimeSettingsobject. For example, the following uses the built-in "speed" settings with updatedlocalizationModes.1await barcodeScanner.updateRuntimeSettings("speed"); 2//await barcodeScanner.updateRuntimeSettings("balance"); //alternative 3//await barcodeScanner.updateRuntimeSettings("coverage"); //alternative 4let settings = await barcodeScanner.getRuntimeSettings(); 5settings.localizationModes = [ 6 Dynamsoft.DBR.EnumLocalizationMode.LM_CONNECTED_BLOCKS, 7 Dynamsoft.DBR.EnumLocalizationMode.LM_SCAN_DIRECTLY, 8 Dynamsoft.DBR.EnumLocalizationMode.LM_LINES, 0, 0, 0, 0, 0 9]; 10await barcodeScanner.updateRuntimeSettings(settings);Try in JSFiddle.
See also settings samples.
Find the full list of the runtime settings here.
Customize the UI (optional)
The built-in UI of the BarcodeScanner object is defined in the file dist/dbr.ui.html . There are a few ways to customize it:
Modify the file dist/dbr.ui.html directly
This option is only possible when you Host the SDK yourself instead of using a public CDN.
Copy the file dist/dbr.ui.html to your application, modify it and use the the API defaultUIElementURL to set it as the default UI
1// This line only takes effect before the method `createInstance()` is called. 2Dynamsoft.DBR.BarcodeScanner.defaultUIElementURL = "THE-URL-TO-THE-FILE";
Append the default UI element to your page, customize it before showing it
1<div id="div-ui-container"></div>
1document.getElementById('div-ui-container').appendChild(scanner.getUIElement()); 2document.getElementsByClassName('dce-btn-close')[0].hidden = true; // Hide the close button
Build the UI element from scratch and connect it to the SDK with the API setUIElement(HTMLElement)
- Embed the video
1<div id="div-ui-container" style="width:100%;height:100%;"> 2 <div class="dce-video-container" style="position:relative;width:100%;height:500px;"></div> 3</div> 4<script> 5 (async () => { 6 let scanner = await Dynamsoft.DBR.BarcodeScanner.createInstance(); 7 await scanner.setUIElement(document.getElementById('div-ui-container')); 8 scanner.onFrameRead = results => { 9 console.log(results); 10 }; 11 scanner.onUniqueRead = (txt, result) => { 12 alert(txt); 13 }; 14 await scanner.show(); 15 })(); 16</script>
The video element will be created and appended to the DIV element with the class
dce-video-container, make sure the class name is the same. Besides, the CSS propertypositionof the DIV element must be eitherrelative,absolute,fixed, orsticky.
- [Optional] Add the camera list and resolution list
If the class names of the created select elements match the default class names, i.e. dce-sel-camera and dce-sel-resolution respectively, the SDK will automatically populate the lists and handle the camera/resolution switching.
1 <div id="div-ui-container" style="width:100%;height:100%;"> 2 <select class="dce-sel-camera"></select><br> 3 <div class="dce-video-container" style="position:relative;width:100%;height:500px;"></div> 4 </div>
1<div id="div-ui-container"> 2 <select class="dce-sel-camera"></select> 3 <select class="dce-sel-resolution"></select> 4 <br> 5 <div class="dce-video-container" style="position:relative;width:100%;height:500px;"></div> 6</div>
By default, only 3 hard-coded resolutions (1920 x 1080, 1280 x 720，640 x 480) are populated as options. You can show a customized set of options by hardcoding them.
1<select class="dce-sel-resolution"> 2 <option class="dce-opt-gotResolution" value="got"></option> 3 <option data-width="1280" data-height="720">1280x720</option> 4 <option data-width="1920" data-height="1080">1920x1080</option> 5</select>
Generally, you need to provide a resolution that the camera supports. However, in case a camera does not support the specified resolution, it usually uses the closest supported resolution. As a result, the selected resolution may not be the actual resolution. In this case, add an option with the class name
dce-opt-gotResolution(as shown above) and the SDK will automatically use it to show the actual resolution.
See the section of the Explore Features guide on UI customization to learn more.
API Documentation
You can check out the detailed documentation about the APIs of the SDK at https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/api-reference/?ver=9.6.42.
System Requirements
DBR requires the following features to work:
-
Secure context (HTTPS deployment)
When deploying your application / website for production, make sure to serve it via a secure HTTPS connection. This is required for two reasons
- Access to the camera video stream is only granted in a security context. Most browsers impose this restriction.
Some browsers like Chrome may grant the access for
http://127.0.0.1andhttp://localhostor even for pages opened directly from the local disk (file:///...). This can be helpful for temporary development and test.- Dynamsoft License requires a secure context to work.
-
WebAssembly,Blob,URL/createObjectURL,Web WorkersThe above four features are required for the SDK to work.
-
MediaDevices/getUserMediaThis API is only required for in-browser video streaming. If a browser does not support this API, the Single Frame Mode will be used automatically. If the API exists but doesn't work correctly, the Single Frame Mode can be used as an alternative way to access the camera.
-
getSettingsThis API inspects the video input which is a
MediaStreamTrackobject about its constrainable properties.
The following table is a list of supported browsers based on the above requirements:
| Browser Name | Version |
|---|---|
| Chrome | v59+1 |
| Firefox | v52+ (v55+ on Android/iOS1) |
| Edge2 | v16+ |
| Safari3 | v11+ |
1 iOS 14.3+ is required for camera video streaming in Chrome and Firefox or Apps using webviews.
2 On Edge, due to strict Same-origin policy, you must host the SDK files on the same domain as your web page.
3 Safari v11.x already has the required features, but it has many other issues, so we recommend v12+.
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.
How to Upgrade
If you want to upgrade the SDK from an old version to a newer one, please see how to upgrade.
Release Notes
Learn about what are included in each release at https://www.dynamsoft.com/barcode-reader/docs/web/programming/javascript/release-notes/?ver=latest.
Next Steps
Now that you have got the SDK integrated, you can choose to move forward in the following directions
- Check out the Official Samples and Demo
- Learn how to make use of the SDK features
- See how the SDK works in Popular Use Cases
No vulnerabilities found.
No security vulnerabilities found.