DEV Community

Cover image for Javascript native barcode detector API
Chris Bongers
Chris Bongers

Posted on • Originally published at daily-dev-tips.com

Javascript native barcode detector API

Today I'm looking at a super cool new API, the Barcode detector API.
This is now shipped as a stable version since Chrome 83.

Be aware it's not a fully supported API by all browsers yet.

The Barcode detector API, as its name suggests can detect barcodes of several formats from an image or video source.

The end result for today will look like this:

Barcode Detector API

Note: You can find a full demo below

Using the Barcode Detector API

Using the barcode API is actually pretty simple.
We can create a detector like this:

// Plain one:
const barcodeDetector = new BarcodeDetector();

// Specific format one:
const barcodeDetector = new BarcodeDetector({
  formats: [
    'aztec',
    'code_128',
    'code_39',
    'code_93',
    'codabar',
    'data_matrix',
    'ean_13',
    'ean_8',
    'itf',
    'pdf417',
    'qr_code',
    'upc_a',
    'upc_e'
  ]
});
Enter fullscreen mode Exit fullscreen mode

As you can see we can pass an array of formats we want to be scanning for, this might come in handy if you are only looking for one type of barcode.

Then we can simply call the detect function and pass an image stream.

try {
  const barcodes = await barcodeDetector.detect(image);
  barcodes.forEach(barcode => doSomething(barcode));
} catch (e) {
  console.error('Barcode detection failed:', e);
}
Enter fullscreen mode Exit fullscreen mode

In our case, we will be using a fixed image to detect the barcode.

<img
  src="https://cdn.hashnode.com/res/hashnode/image/upload/v1619338701344/-rJKsBrhI.png"
  crossorigin
  alt="QR Coden Daily Dev Tips"
/>
Enter fullscreen mode Exit fullscreen mode

And now we can simply create a barcode detector that will use this image, and output all data in a newly created pre tag.

const barcodeDetector = new BarcodeDetector();
const image = document.querySelector('img');

barcodeDetector
  .detect(image)
  .then(barcodes => {
    let pre = document.createElement('pre');
    pre.innerHTML = JSON.stringify(barcodes, null, 2);
    image.after(pre);
  })
  .catch(console.error);
Enter fullscreen mode Exit fullscreen mode

And it gives us the result of a bounding box, corner-points, and the actual value.

You can try this out on the following Codepen.

Browser support

As mentioned the API is still in progress being rolled out, as of Chrome 83 and Edge 82 we can use it.
However, Firefox does not yet support it.

CSS barcode detector support

Thank you for reading, and let's connect!

Thank you for reading my blog. Feel free to subscribe to my email newsletter and connect on Facebook or Twitter

Top comments (5)

Collapse
 
lexlohr profile image
Alex Lohr

This is a nice summary. There's also a polyfill for those Browsers that don't support it.

Collapse
 
xulihang profile image
xulihang

The polyfill can't read 2D codes. Here is a one which reads all kinds of barcode formats: npmjs.com/package/barcode-detection

Collapse
 
dailydevtips1 profile image
Chris Bongers

Ah yes, indeed nice mention.

Collapse
 
artydev profile image
artydev

Great, thank you Chris :-)

Collapse
 
dailydevtips1 profile image
Chris Bongers

Thanks, glad you like it!