Barcode Scanner JavaScript Edition - User Guide
--
-
- Barcode Scanner JavaScript Edition - User Guide -
- License -
- Quick Start: Hello World Example -
- Next Steps -
Build a Web-Based Barcode Scanner Using Just a Few Lines of JavaScript
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:
-
@@ -277,16 +266,8 @@
Full License
Quick Start: Hello World Example
<!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 src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.0.3000/dist/dbr.bundle.js"></script>
<script>
// Initialize the Dynamsoft Barcode Scanner
const barcodeScanner = new Dynamsoft.BarcodeScanner({
@@ -296,14 +277,17 @@ Quick Start: Hello World Example
(async () => {
// Launch the scanner and wait for the result
const result = await barcodeScanner.launch();
- alert(result.barcodeResults[0].text);
+ // Display the first detected barcode's text in an alert
+ if (result.barcodeResults.length) {
+ alert(result.barcodeResults[0].text);
+ }
})();
</script>
</body>
</html>
-
+
@@ -311,26 +295,18 @@
Quick Start: Hello World Example
-
+
Step 1: Setting up the HTML and Including the Barcode Scanner
-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.
+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>
+ <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.0.3000/dist/dbr.bundle.js"></script>
</body>
-
</html>
In this example, we include the precompiled Barcode Scanner SDK script via public CDN in the header.
@@ -341,17 +317,17 @@Step 1: Se
- jsDelivr
- <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
+ <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.0.3000/dist/dbr.bundle.js"></script>
- UNPKG
- <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
+ <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.0.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
+ npm i dynamsoft-barcode-reader-bundle@11.0.3000
# or
- yarn add dynamsoft-barcode-reader-bundle@10.5.3000
+ yarn add dynamsoft-barcode-reader-bundle@11.0.3000
As 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.
@@ -360,26 +336,26 @@ Step 1: Se
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/.
Download Dynamsoft Barcode Reader JavaScript Package
+The resources are located in the ./dist/ directory.
From npm
- npm i dynamsoft-barcode-reader-bundle@10.5.3000
+ npm i dynamsoft-barcode-reader-bundle@11.0.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.
+The resources are located at the path node_modules/<pkg>, without @<version>. You can copy it elsewhere and add @<version> tag.
[!IMPORTANT]
Since "nodemodules" is reserved for Node.js dependencies, and in our case the package is used only as static resources, we recommend either renaming the "nodemodules" 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>
+<script src="path/to/dynamsoft-barcode-reader-bundle@11.0.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.
Step 2: Initializing the Barcode Scanner
// Initialize the Dynamsoft Barcode Scanner
-const Barcodescanner = new Dynamsoft.BarcodeScanner({
+const barcodescanner = new Dynamsoft.BarcodeScanner({
// Please don't forget to replace YOUR_LICENSE_KEY_HERE
license: "YOUR_LICENSE_KEY_HERE",
});
@@ -393,14 +369,16 @@ Step 2: Initializing the Barcod
const barcodescanner = new Dynamsoft.BarcodeScanner({
license: "YOUR_LICENSE_KEY_HERE",
scanMode: Dynamsoft.EnumScanMode.SM_MULTI_UNIQUE,
- showResultView: true,
});
Step 3: Launching the Barcode Scanner
(async () => {
// Launch the scanner and wait for the result
const result = await barcodescanner.launch();
- alert(result.barcodeResults[0].text);
+ // Display the first detected barcode's text in an alert
+ if (result.barcodeResults.length) {
+ 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.
@@ -412,8 +390,8 @@ Next Steps
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
+- Check out the Official Samples and Demo
+- Learn about the APIs of BarcodeScanner
<script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
+ <script src="https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.0.3000/dist/dbr.bundle.js"></script>
- UNPKG
- <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@10.5.3000/dist/dbr.bundle.js"></script>
+ <script src="https://unpkg.com/dynamsoft-barcode-reader-bundle@11.0.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
+ npm i dynamsoft-barcode-reader-bundle@11.0.3000
# or
- yarn add dynamsoft-barcode-reader-bundle@10.5.3000
+ yarn add dynamsoft-barcode-reader-bundle@11.0.3000
As 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.
@@ -360,26 +336,26 @@ Step 1: Se
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/.
Download Dynamsoft Barcode Reader JavaScript Package
+The resources are located in the ./dist/ directory.
From npm
- npm i dynamsoft-barcode-reader-bundle@10.5.3000
+ npm i dynamsoft-barcode-reader-bundle@11.0.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.
+The resources are located at the path node_modules/<pkg>, without @<version>. You can copy it elsewhere and add @<version> tag.
[!IMPORTANT]
Since "nodemodules" is reserved for Node.js dependencies, and in our case the package is used only as static resources, we recommend either renaming the "nodemodules" 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>
+<script src="path/to/dynamsoft-barcode-reader-bundle@11.0.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.
Step 2: Initializing the Barcode Scanner
// Initialize the Dynamsoft Barcode Scanner
-const Barcodescanner = new Dynamsoft.BarcodeScanner({
+const barcodescanner = new Dynamsoft.BarcodeScanner({
// Please don't forget to replace YOUR_LICENSE_KEY_HERE
license: "YOUR_LICENSE_KEY_HERE",
});
@@ -393,14 +369,16 @@ Step 2: Initializing the Barcod
const barcodescanner = new Dynamsoft.BarcodeScanner({
license: "YOUR_LICENSE_KEY_HERE",
scanMode: Dynamsoft.EnumScanMode.SM_MULTI_UNIQUE,
- showResultView: true,
});
Step 3: Launching the Barcode Scanner
(async () => {
// Launch the scanner and wait for the result
const result = await barcodescanner.launch();
- alert(result.barcodeResults[0].text);
+ // Display the first detected barcode's text in an alert
+ if (result.barcodeResults.length) {
+ 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.
@@ -412,8 +390,8 @@ Next Steps
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
+- Check out the Official Samples and Demo
+- Learn about the APIs of BarcodeScanner