Easy Barcode Scanner

The Easy Barcode Scanner is a lightweight, user-friendly wrapper for the Dynamsoft Barcode Reader SDK. It simplifies the barcode scanning process, making it easier to integrate into your web applications with minimal effort.

Features

• Supports video-based barcode scanning
• Handles multiple barcodes with ease
• Simple integration with just a few lines of code

Out-of-the-box Scanning

The simplest way to use Easy Barcode Scanner requires only one line code to create a video decoding web application.

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/dbr.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/gh/Dynamsoft/[email protected]/dist/easy-barcode-scanner.js"
  data-license=""></script>
<script>
  EasyBarcodeScanner.scan().then(txt=>alert(txt)).catch(ex=>alert(ex.message || ex));
</script>

Source Code >> | Run in github.io >>

Create Your Own Scanner for Further Control

You can also create your own scanner instance to have more control over the entire workflow. For more details on the encapsulated functionality, refer to src/index.ts, and feel free to modify it based on your specific needs.

<div id="camera-view-container" style="height:90vh"></div>
<button id="btn-scan">scan</button>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/dbr.bundle.js"></script>
<script src="https://cdn.jsdelivr.net/gh/Dynamsoft/[email protected]/dist/easy-barcode-scanner.js"
  data-license=""></script>
<script>
  let pScanner, scanner;
  document.getElementById('btn-scan').addEventListener('click', async()=>{
    try{
      scanner = await (pScanner || (pScanner = EasyBarcodeScanner.createInstance()));
      // Optional. Insert the UI into the specified element.
      // Otherwise the UI will be inserted into `document.body`.
      document.querySelector("#camera-view-container").append(scanner.getUIElement());
      scanner.onUniqueRead = (txt) => { console.log(txt); };
      await scanner.open();
    }catch(ex){
      // If camera doesn't exist or is occupied, the camera may fail to open.
      // So it's better to use `try-catch`.
      console.error(ex);
      alert(ex.message || ex);
    }
  });
</script>

How to use it in frameworks like Angular, React, and Vue

To integrate Easy Barcode Scanner into your framework, follow these steps:

1. Install the necessary package:

npm i [email protected] -E

2. Copy the src/index.ts file from the library into your project. Rename it as needed, for example: [your-path]/easy-barcode-reader.ts.

Example 1: Simple Out-of-the-box Scan

For a simpler implementation, this example shows how to scan with a single function:

import EasyBarcodeScanner from '[your-path]/easy-barcode-reader';

EasyBarcodeScanner.license = ""; // Add your license key here

async scan(){
  try{
    alert(await EasyBarcodeScanner.scan());
  }catch(ex){
    console.error(ex);
    alert(ex.message || ex);
  }
}

Example 2: Setting Up a Scanner

This example shows how to create your own barcode scanner, giving you more control over the details:

import EasyBarcodeScanner from '[your-path]/easy-barcode-reader';

EasyBarcodeScanner.license = ""; // Add your license key here

let pScanner = null;
let scanner = null;

async mount(){
  try{
    scanner = await (pScanner || (pScanner = EasyBarcodeScanner.createInstance()));
    cameraViewContainer.append(scanner.getUIElement()); // Optional.
    scanner.onUniqueRead = (txt) => { console.log(txt); };
    await scanner.open();
  }catch(ex){
    console.error(ex);
    alert(ex.message || ex);
  }
}
beforeUnmount(){
  // Clean up to free resources
  try{ (await pScanner)?.dispose(); }catch(_){}
}

// usage example in a tsx/jsx component
<div ref={cameraViewContainer}></div>

• The mount() function initializes the scanner and listens for barcode readings.
• The beforeUnmount() function disposes of the scanner instance to prevent memory leaks.

Customize the UI

The built-in UIs are located in files like xxx.ui.html. You can copy xxx.ui.html into your project, modify it as needed, and pass its path to the createInstance or scan API to use the customized version.

// 'https://cdn.jsdelivr.net/gh/Dynamsoft/[email protected]/easy-barcode-scanner.ui.html' by default
EasyBarcodeScanner.scan(ui?: string|HTMLElement);
// 'https://cdn.jsdelivr.net/npm/[email protected]/dist/dce.mobile-native.ui.html' by default
EasyBarcodeScanner.createInstance(ui?: string|HTMLElement);

You can refer to customize the UI of CameraEnhancer for more details.

All supported barcodes

You can use the code snippet from theOut-of-the-box Scanning section to focus the camera on one or more barcodes. If only one barcode is detected, the result will be displayed immediately. If multiple codes are scanned, an additional interactive step allows you to choose the target.

Please note that some barcode types are not supported by default for performance concern. Please check here to change settings.

License Information

The license used in this sample is an automatically requested trial license, only valid for 24 hours and applicable to any newly authorized browser. To test the SDK further, you can request a 30-day free trial license via the Request a Trial License link.

The license can be directly configured within the script tag when including the script file.

<script src="https://cdn.jsdelivr.net/gh/Dynamsoft/[email protected]/dist/easy-barcode-scanner.js"
data-license="[YOUR-LICENSE]"></script>