Repository files navigation

Looking for an actively maintained barcode scanning library with commercial support?Check outSTRICH – Barcode Scanning for Web Apps.

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.

SeeProjects andMilestones for what is currently done and what's planned next. 👀

NOTE: While we do not have the time to actively maintain zxing-js anymore, we are open to new maintainers taking the lead.

SeeLive Preview in browser.

Note: All the examples are using ES6, be sure is supported in your browser or modify as needed, Chrome recommended.

npm i @zxing/library --save

or

yarn add @zxing/library

On iOS-Deviceswith iOS < 14.3 camera access works only in native Safari and not in other Browsers (Chrome,...) or Apps that use an UIWebView or WKWebView. This is not a restriction of this library but of the limited WebRTC support by Apple. The behavior might change in iOS 11.3 (Apr 2018?, not tested) as statedhere

iOS 14.3 (released in december 2020) now supports WebRTC in 3rd party browsers as well 🎉

The browser layer is using theMediaDevices web API which is not supported by older browsers.

You can use external polyfills likeWebRTC adapter to increase browser compatibility.

Also, note that the library is using theTypedArray (Int32Array,Uint8ClampedArray, etc.) which are not available in older browsers (e.g. Android 4 default browser).

You can usecore-js to add support to these browsers.

In the PDF 417 decoder recent addition, the library now makes use of the newBigInt type, whichis not supported by all browsers as well. There's no way to polyfill that and ponyfill libraries areway to big, but even if PDF 417 decoding relies onBigInt the rest of the library shall work ok in browsers that doesn't support it.

There's no polyfills forBigInt in the way it's coded in here.

// use with commonJSconst{ MultiFormatReader, BarcodeFormat}=require('@zxing/library');// or with ES6 modulesimport{MultiFormatReader,BarcodeFormat}from'@zxing/library';consthints=newMap();constformats=[BarcodeFormat.QR_CODE,BarcodeFormat.DATA_MATRIX/*, ...*/];hints.set(DecodeHintType.POSSIBLE_FORMATS,formats);constreader=newMultiFormatReader();constluminanceSource=newRGBLuminanceSource(imgByteArray,imgWidth,imgHeight);constbinaryBitmap=newBinaryBitmap(newHybridBinarizer(luminanceSource));reader.decode(binaryBitmap,hints);

SeeContributing Guide for information regarding porting approach and reasoning behind some of the approaches taken.

Special thanks to all the contributors who have contributed for this project. We heartly thankful to you all.

And a special thanks to@aleris who created the project itself and made available the initial QR code port.