If it doesn't, we gonna make it.
ZXing ("zebra crossing") is an open-source, multi-format 1D/2D barcode image processing library implemented in Java, with ports to other languages.
See Projects and Milestones for what is currently done and what's planned next. ๐
1D product | 1D industrial | 2D |
---|---|---|
QR Code | ||
Data Matrix (no docs) | ||
Code 128 (no docs) | ||
EAN-13 (no docs) | PDF 417 (in-progress) | |
ITF (no docs) | ||
See Live Preview in browser.
Note: All the examples are using ES6, be sure is supported in your browser or modify as needed, Chrome recomended.
npm i @zxing/library --save
or
yarn add @zxing/library
Examples below are for QR barcode, all other supported barcodes work similary.
To use from JS you need to include what you need from build/umd
folder (for example zxing.min.js
).
The browser layer is using the MediaDevices web API which is not supported by older browsers.
You can use external polyfills like WebRTC adapter to increase browser compatiblity.
Also, note that the library is using the TypedArray
(Int32Array
, Uint8ClampedArray
, etc.) which are not available in older browsers (e.g. Android 4 default browser).
You can use core-js to add support to these browsers.
You can include directly the classes you need, for example:
import { BrowserQRCodeReader, VideoInputDevice } from '@zxing/library';
To use in node you will need to provide an implementation of LuminanceSource
for an image. A starting point is SharpImageLuminanceSource
from tests that is using sharp image processing Node library.
No examples are availabe for now, however you can have a look at the extensive tests cases.
To display the input from the video camera you will need to add a video element in the HTML page:
<video id="video" width="300" height="200" style="border: 1px solid gray"></video>
To start decoding, first obtain a list of video input devices with:
const codeReader = new ZXing.BrowserQRCodeReader();
codeReader.getVideoInputDevices()
.then(videoInputDevices => {
videoInputDevices.forEach(
device => console.log(`${device.label}, ${device.deviceId}`)
);
})
.catch(err => console.error(err));
If there is just one input device you can use the first deviceId and the video element id (in the example below is also 'video') to decode:
const firstDeviceId = videoInputDevices[0].deviceId;
codeReader.decodeFromInputVideoDevice(firstDeviceId, 'video')
.then(result => console.log(result.text))
.catch(err => console.error(err));
If there are more input devices then you will need to chose one for codeReader.decodeFromInputVideoDevice
device id parameter.
You can also provide undefined
for the device id parameter in which case the library will automatically choose the camera, prefering the main (environment facing) camera if more are available:
codeReader.decodeFromInputVideoDevice(undefined, 'video')
.then(result => console.log(result.text))
.catch(err => console.error(err));
Similar as above you can use a video element in the HTML page:
<video id="video" width="300" height="200" style="border: 1px solid gray"></video>
And to decode the video from an url:
const codeReader = new ZXing.BrowserQRCodeReader();
const videoSrc = 'your url to a video';
codeReader.decodeFromVideoSource(videoSrc, 'video')
.then(result => console.log(result.text))
.catch(err => console.error(err));
You can also decode the video url without showing it in the page, in this case no video
element is needed in HTML.
codeReader.decodeFromVideoSource(videoSrc)
.then(result => console.log(result.text))
.catch(err => console.error(err));
Similar as above you can use a img element in the HTML page (with src attribute set):
<img id="img" src="qrcode-image.png" width="200" height="300" style="border: 1px solid gray"></img>
And to decode the image:
const codeReader = new ZXing.BrowserQRCodeReader();
const img = document.getElementById('img');
codeReader.decodeFromImage(img)
.then(result => console.log(result.text))
.catch(err => console.error(err));
You can also decode the image url without showing it in the page, in this case no img
element is needed in HTML:
const imgSrc = 'url to image';
codeReader.decodeFromImage(undefined, imgSrc)
.then(result => console.log(result.text))
.catch(err => console.error(err));
Or decode the image url directly from an url, with an img
element in page (notice no src
attribute is set for img
element):
<img id="img" width="200" height="300" style="border: 1px solid gray"></img>
const imgSrc = 'url to image';
const imgDomId = 'img-to-decode';
codeReader.decodeFromImage(imgDomId, imgSrc)
.then(result => console.log(result.text))
.catch(err => console.error(err));
To generate a QR Code SVG image include 'zxing.qrcodewriter.min.js' from build/vanillajs
. You will need to include an element where the SVG element will be appended:
<div id="result"></div>
And then:
const codeWriter = new ZXing.BrowserQRCodeSvgWriter('result');
const svgElement = codeWriter.write(input, 300, 300);
See Contributing Guide for information regarding porting approach and reasoning behind some of the approaches taken.