@justinribeiro/barcode-reader
v0.1.0
Published
A web component that uses the Shape Detection API and module scripts in DedicatedWorker to detect barcodes.
Downloads
45
Maintainers
Readme
<barcode-reader>
A web component that reads barcodes via the Shape Detection API via a Web Worker.
Features
- Uses Shape Detection API available in Chrome M74 (see https://www.chromestatus.com/feature/4757990523535360).
- Module scripts on DedicatedWorker. You can try the feature with '--enable-experimental-web-platform-features' flag (see https://crbug.com/680046)
- Uses Comlink for the proxy of the worker
- Built as a web component via LitElement
Experimental
Please note, this is not production ready. It's not polyfilled, it relies on an experimental platform feature for the Web Worker, and generally I've just been toying with it in various Chrome builds for quite some time.
Use at your own peril! 🐉🔥
A more complete example
If you're looking for a more complete PWA example of using barcodes on the web, I highly recommend Paul Kinlans' QR Snapper as well as his blog.
Install
This web component is built with Polymer 3 and ES modules in mind and is available on NPM:
Install barcode-reader:
npm i @justinribeiro/barcode-reader
# or
yarn add @justinribeiro/barcode-reader
After install, import into your project:
import 'barcode-reader';
Finally, use as required:
<barcode-reader></barcode-reader>
<script>
customElements.whenDefined('barcode-reader').then(() => {
const barcodeReader = document.querySelector('barcode-reader');
// start the camera stream
// always looks for
// facingMode: {
// exact: 'environment',
// }
barcodeReader.start();
// component returns a custom event with results
document.addEventListener('barcodes-found', (event) => {
console.log(event.detail.barcodes);
// if you want to stop streaming, ala, I'm hiding you now
barcodeReader.stop();
}, false);
});
</script>