Table of Contents
- [How to use:](#how-to-use)
- [isDark](#isdark)
- [getModuleCount](#getmodulecount)
- [make](#make)
- [createSvgTag](#createsvgtag)
- [createImgTag](#createimgtag)
qrcode-generator-es6
How to use:
First run:npm install --save qrcode-generator-es6
Then use it in your code like:import qrcode from './qrcode.js';
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 withaddData
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
Parametersrow
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
Parametersargs
Object
- `args.drawCell` **[function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** The path of the obstruction image.
- `args.cellSize`
Returns String An svg tag as a string.createImgTag
ParameterscellSize
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.