This user guide provides a step-by-step walkthrough of a "Hello World" web application using the BarcodeScanner JavaScript Edition.
The BarcodeScanner class offers the following features:
-
High-level APIs that deliver core functionality with a single line of code.
-
Pre-built UI components for fast and easy integration.
-
Intuitive configuration objects that streamline both algorithm and UI setup.
We recommend using this guide as a reference when creating your own application. If you are looking for a fully customizable barcode decoding library, you are welcome to use the Foundational APIs. Before starting, ensure the basic requirements are met.
- Internet connection
- A supported browser
- Camera access
Tip
Please refer to system requirements for more details.
When getting started with Barcode Scanner, we recommend getting your own 30-day trial license
Important
The trial license can be renewed via the customer portal twice, each time for another 15 days, giving you a total of 60 days to develop your own application using the solution. Please contact the Dynamsoft Support Team if you need more time for a full evaluation.
If you are fully satisfied with the solution and would like to move forward with a full license, please contact the Dynamsoft Sales Team.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft Barcode Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
</head>
<body>
<h1 style="font-size: large">Dynamsoft Barcode Scanner</h1>
<script>
// Initialize the Dynamsoft Barcode Scanner
const barcodeScanner = new Dynamsoft.BarcodeScanner({
// Please don't forget to replace YOUR_LICENSE_KEY_HERE
license: "YOUR_LICENSE_KEY_HERE",
});
(async () => {
// Launch the scanner and wait for the result
const result = await barcodeScanner.launch();
alert(result.barcodeResults[0].text);
})();
</script>
</body>
</html>
As outlined earlier, this guide will help you create a simple Hello World barcode scanning application using vanilla JavaScript. The full sample code is also available in the GitHub repository.
The first step before writing the code is to include the SDK in your application. You can simply include the SDK by using the precompiled script.
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Dynamsoft Barcode Scanner - Hello World</title>
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
</head>
<body>
<h1 style="font-size: large">Dynamsoft Barcode Scanner</h1>
</body>
</html>In this example, we include the precompiled Barcode Scanner SDK script via public CDN in the header.
The simplest way to include the SDK is to use either the jsDelivr or UNPKG CDN.
-
jsDelivr
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
-
UNPKG
<script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.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:
npm i dynamsoft-barcode-reader-bundle@10.5.3000
# or
yarn add dynamsoft-barcode-reader-bundle@10.5.3000As for package managers like npm or yarn, you likely need to specify the location of the engine files as a link to a CDN. Please see the BarcodeScannerConfig API for a code snippet on how to set the engineResourcePaths.
Alternatively, you may choose to download the SDK and host the files on your own server or preferred CDN. This approach provides better control over versioning and availability.
-
From the website
Download Dynamsoft Barcode Reader JavaScript Package
The resources are located at path
dynamsoft/distributables/. -
From npm
npm i dynamsoft-barcode-reader-bundle@10.5.3000
The resources are located at the path
node_modules/<pkg>, without@<version>. You can copy it elsewhere and add@<version>tag. One more thing to do is to specify the engineResourcePaths so that the SDK can correctly locate the resources.[!IMPORTANT] Since "node_modules" is reserved for Node.js dependencies, and in our case the package is used only as static resources, we recommend either renaming the "node_modules" folder or moving the "dynamsoft-" packages to a dedicated folder for static resources in your project to facilitate self-hosting.
You can typically include SDK like this:
<script src="path/to/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>Barcode Scanner comes with a Ready-to-Use UI. When the Barcode Scanner launches, it creates a container which it populates with the Ready-to-Use UI.
// Initialize the Dynamsoft Barcode Scanner
const Barcodescanner = new Dynamsoft.BarcodeScanner({
// Please don't forget to replace YOUR_LICENSE_KEY_HERE
license: "YOUR_LICENSE_KEY_HERE",
});This is the simplest way to initialize the Barcode Scanner. The configuration object must include a valid license key. Without it, the scanner will fail to launch and display an error. For help obtaining a license, see the licensing section.
Tip
By default, the BarcodeScanner scans a single barcode at a time. However, it also supports a MULTI_UNIQUE scanning mode, which continuously scans and accumulates unique results in real time. You can enable this mode by modifying the BarcodeScannerConfig as follows:
// Initialize the Dynamsoft Barcode Scanner in MULTI_UNIQUE mode
const barcodescanner = new Dynamsoft.BarcodeScanner({
license: "YOUR_LICENSE_KEY_HERE",
scanMode: Dynamsoft.EnumScanMode.SM_MULTI_UNIQUE,
showResultView: true,
});(async () => {
// Launch the scanner and wait for the result
const result = await barcodescanner.launch();
alert(result.barcodeResults[0].text);
})();Now that the Barcode Scanner has been initialized and configured, it is ready to be launched! Upon launch, the Barcode Scanner presents the main BarcodeScannerView UI in its container on the page, and is ready to start scanning. By default, we use the SINGLE scanning mode, which means only one decoding result will be included in the final result. In the code above, we directly alerted the successfully decoded barcode text on the page.
Note
In the Hello World sample, after a successfully decoding process, the scanner closes and the user is met with an empty page. In order to open the scanner again, the user must refresh the page. You may choose to implement a more user-friendly behavior in a production environment, such as presenting the user with an option to re-open the Barcode Scanner upon closing it.
Now that you've implemented the basic functionality, here are some recommended next steps to further explore the capabilities of the Barcode Scanner
- Learn how to Customize the Barcode Scanner
- Check out the Official Samples and Demo
- Learn about the APIs of BarcodeScanner
