@nico-martin/barcode-detector
v0.7.2
Published
** !! **!! This is a fork of the [BarcodeDetector Polyfill](https://github.com/gruhn/barcode-detector) that uses a fork of [jsQR](https://github.com/cozmo/jsQR) that includes the ISO-8859-1 fix by [chatelao](https://github.com/chatelao) !!** !! **
Downloads
7
Readme
** !! !! This is a fork of the BarcodeDetector Polyfill that uses a fork of jsQR that includes the ISO-8859-1 fix by chatelao !! !! **
:construction: WIP: BarcodeDetector Polyfill :construction:
Spec compliant polyfill of the Barcode Detection API.
It can be used for barcode/QR-code recognition in images from various kinds of
sources including <canvas>
, <img>
, <image>
(inside SVGs), <video>
, File
, Blob
, ImageData
, ImageBitmap
, OffscreenCanvas
.
[TODO: live demos]
Design goals:
- spec compliance
- support as many barcode formats as possible
- detect multiple codes in one image
- provide position/coordinate information of detected codes
- sufficient performance to process live video streams
Installation
npm install barcode-detector
import BarcodeDetector from "barcode-detector"
// polyfill unless already supported
if (!("BarcodeDetector" in window)) {
window.BarcodeDetector = BarcodeDetector
}
Usage
// pick barcode formats. Other formats will be ignored
const barcodeDetector = new BarcodeDetector({ formats: ["qr_code"] })
// directly pass an image element, video element, ...
const barcodes = await barcodeDetector.detect(someImageSource)
// can detect multiple barcodes in one image
const [ barcode1, barcode2, ...evenMoreBarcodes ] = barcodes
// access encoded string
const { rawValue } = barcode1
For in-depth documentation checkout the corresponding MDN page.
Supported Formats
src/BarcodeDetectorJsqr.ts
:
- :x:
aztec
- :x:
code_128
- :x:
code_39
- :x:
code_93
- :x:
codabar
- :x:
data_matrix
- :x:
ean_13
- :x:
ean_8
- :x:
itf
- :x:
pdf417
- :heavy_check_mark:
qr_code
- :x:
upc_a
- :x:
upc_e
src/BarcodeDetectorZXing.ts
(not exposed at the moment. See #1):
- :heavy_check_mark:
aztec
- :heavy_check_mark:
code_128
- :heavy_check_mark:
code_39
- :x:
code_93
- :x:
codabar
- :heavy_check_mark:
data_matrix
- :heavy_check_mark:
ean_13
- :heavy_check_mark:
ean_8
- :heavy_check_mark:
itf
- :heavy_check_mark:
pdf417
- :heavy_check_mark:
qr_code
- :x:
upc_a
- :x:
upc_e