Scan Barcodes on a Mobile Device

Use the BarcodeScanner API

To develop a Lightning web component with barcode scanning features, use the BarcodeScanner API.

• Import BarcodeScanner into your component definition to make the BarcodeScanner API functions available to your code.
• Test to make sure BarcodeScanner is available before you call scanning lifecycle functions.
• Use the scanning lifecycle functions to start, continue, and stop scanning.

Add BarcodeScanner to a Lightning Web Component

In your component’s JavaScript file, import BarcodeScanner using the standard JavaScript import statement. Specifically, import the getBarcodeScanner factory function from the lightning/mobileCapabilities module, like so:

import { getBarcodeScanner } from "lightning/mobileCapabilities";

After it’s imported into your component, use the factory function to get an instance of BarcodeScanner. With your BarcodeScanner instance, use the utility functions and constants to verify scanner availability and to configure scans. Use the scanning lifecycle functions to perform scanning operations.

Test BarcodeScanner Availability

BarcodeScanner depends on physical device hardware and platform features. A component that uses BarcodeScanner renders without errors on a desktop computer, but scanning functions fail. To avoid these errors, test if BarcodeScanner functionality is available before you use it.

import { LightningElement } from 'lwc';
import { getBarcodeScanner } from 'lightning/mobileCapabilities';
export default class ImplementBarcodeScanner extends LightningElement {
  const myScanner = getBarcodeScanner();

  barcodeResults = 'Nothing scanned yet!';

  handleBeginScanClick(event) {
    if(myScanner.isAvailable()) {
      // Perform scanning operations
      let scanningOptions = {
        "barcodeTypes": ["code128","code39", "code93", "ean13", "ean8", "upca", "upce", "qr", "datamatrix", "itf", "pdf417"], "instructionText":"Position barcode in the scanner view.\nPress x to stop.",
"successText":"Successful Scan!"
      };
      myScanner.scan(scanningOptions)
        .then((results) => {
          // Do something with the results of the scan
          this.barcodeResults = '';
          results.forEach(result => {
            this.barcodeResults += 'type: ' + result.type + ', value: ' + result.value + '\n'; 
          });
        })
        .catch((error) => {
          // Handle cancellation and scanning errors here
          this.barcodeResults = 'Error code: ' + error.code + '\nError message: ' + error.message;
        })
        .finally(() => {
          myScanner.dismiss();
        });
  } else {
      // Scanner not available
      // Not running on hardware with a scanner
      // Handle with message, error, beep, and so on
      this.barcodeResults = 'Problem initiating scanner.  Are you using a mobile device?';
    }
  }
}

Supported Barcode Types

• aztec
• code39
• code93
• code128
• dataMatrix
• ean8
• ean13
• interleaved2of5
• pdf417
• qr
• upce

Scan a Barcode

Scan with BarcodeScanner using the scanning lifecycle functions.

• Start a scan with scan(options).
• Handle the result of the scan, which is returned in the form of a promise.
• End the scan with dismiss().

For example:

myScanner
  .scan(scanningOptions)
  .then((result) => {
    // Do something with the result of the scan
    console.log(result);
    this.scannedBarcode = result.value;
  })
  .catch((error) => {
    // Handle cancellation and scanning errors here
    console.error(error);
  })
  .finally(() => {
    myScanner.dismiss();
  });

See scan(options) for more details of how to handle scan results, handle errors, and so on.