/qrcode-generator-es6

QR Code Generator implementation in JavaScript, Java and more.

Primary LanguageJavaScriptOtherNOASSERTION

Table of Contents

qrcode-generator-es6

Github Build Status

How to use:

First run:

npm install --save qrcode-generator-es6

Then use it in your code like:

import qrcode from 'qrcode-generator-es6';

const qr = new qrcode(0, 'H');
qr.addData('This is my data');
qr.make();
my_element.innerHTML = qr.createSvgTag({});

qrcode

Displays a QR code. Set the code data with addData and, call make and then call createSvgTag or createImgTag.

See gallery.html for an example.

Parameters

  • typeNumber integer The minimum QR code type number from 1 to 40. Using 0 allows any QR code type number.
  • errorCorrectionLevel String 'L','M','Q','H'

isDark

Parameters

  • row
  • col

Returns boolean true if the module at row, col is dark.

getModuleCount

Returns integer The module count in one dimension of the QR code. The total number of modules is the square of this value.

make

Call this when done adding data before getting the generated QR code image.

createSvgTag

Parameters

  • args Object
    • args.drawCell function? A callback with arguments column, row, x, y to draw a cell. x, y are the coordinates to draw it at. c, y are the QR code module indexes. Returns the svg element child string for the cell.
    • args.cellColor function? A callback which returns the color for the cell. By default, a function that returns black. Unused if drawCell is provided.
    • args.margin integer? The margin to draw around the QR code, by number of cells.
    • args.obstruction Object? An image to place in the center of the QR code.
      • args.obstruction.width integer Width of the obstruction as a percentage of QR code width.
      • args.obstruction.height integer Height of the obstruction as a percentage of QR code height.
      • args.obstruction.path String The path of the obstruction image.
    • args.cellSize

Returns String An svg tag as a string.

createImgTag

Parameters

  • cellSize integer The size of a module in pixels.
  • margin integer The margin to draw around the QR code in pixels.

Returns String An img tag as a string.

stringToBytesFuncs

stringToBytes

QRMode

QRErrorCorrectionLevel

QRMaskPattern