sin-tanaka / vue-quagga

quaggaJS's wrapper Barcode Reader/Scanner component for Vue.js.
MIT License
53 stars 34 forks source link

vue-quaggajs

quaggajs 's wrapper for Vue.js

Installtion

npm

npm i vue-quaggajs

Basic Example

<template>
  <div>
    <v-quagga :onDetected="logIt" :readerSize="readerSize" :readerTypes="['ean_reader']"></v-quagga>
  </div>
</template>

<script>
import Vue from 'vue'
import VueQuagga from 'vue-quaggajs';

// register component 'v-quagga'
Vue.use(VueQuagga);

export default {
  name: 'VueBarcodeTest',
  data () {
    return {
      readerSize: {
        width: 640,
        height: 480
      },
      detecteds: []
    }
  },
  methods: {
    logIt (data) {
      console.log('detected', data)
    }

  }
}
</script>

Usage

onDetected : function(result)

Reference: Quagga.onDetected(callback)

default function:

function (result) {
  console.log('detected: ', result);
}

onProcessed : function(result)

Reference: Quagga.onProcessed(callback)

default function:

function (result) {
  let drawingCtx = Quagga.canvas.ctx.overlay,
    drawingCanvas = Quagga.canvas.dom.overlay;

  if (result) {
    if (result.boxes) {
      drawingCtx.clearRect(0, 0, parseInt(drawingCanvas.getAttribute("width")), parseInt(drawingCanvas.getAttribute("height")));
      result.boxes.filter(function (box) {
        return box !== result.box;
      }).forEach(function (box) {
        Quagga.ImageDebug.drawPath(box, {x: 0, y: 1}, drawingCtx, {color: "green", lineWidth: 2});
      });
    }
    if (result.box) {
      Quagga.ImageDebug.drawPath(result.box, {x: 0, y: 1}, drawingCtx, {color: "#00F", lineWidth: 2});
    }

    if (result.codeResult && result.codeResult.code) {
      Quagga.ImageDebug.drawPath(result.line, {x: 'x', y: 'y'}, drawingCtx, {color: 'red', lineWidth: 3});
    }
  }
},

readerTypes: String[]

Set reading barcode type.

Reference: https://github.com/serratus/quaggaJS#decoder

default: ['code_128_reader']

readerSize: Object {width: Number, height: Number}

Set reader size. it affects

default:

{
  width: 640,
  height: 480,
}

aspectRatio: Object {min: Number, max: Number}

Set aspect ratio. it affects

default:

{
  min: 1,
  max: 2,
}