xdamman/qr-with-logo

For usage within NodeJS, an npm package which allows for the creation of a QR code with an embedded logo. Easily place logo within the center of a QR code using Node JS.

qr-with-logo is a Node package developed to allow for the creation of QR codes with embedded logo images.

Installation

Use node package manager (npm) to install install QRLogo.

npm install --save qr-with-logo

Saving as PNG

const QRLogo = require("qr-with-logo");

const data = JSON.stringify({
  name: "Zacharie Happel",
  job: "Student/Intern",
  grade: "Senior",
});

await QRLogo.generateQRWithLogo(
  data,
  "test/qrlogo.png",
  {},
  "PNG",
  "qrwithlogo.png"
);

Base64

const QRLogo = require("qr-with-logo");

const data = JSON.stringify({
  name: "Zacharie Happel",
  job: "Student/Intern",
  grade: "Senior",
});

const base64 = await QRLogo.generateQRWithLogo(
  data,
  "test/qrlogo.png",
  {},
  "base64"
);

Information

QRLogo currently only supports saving images as PNG and the exportation of base64 formatted data.

qrcode to facilitate the creation of the QR codes, and the sharp npm package as the means to which images are overlaid.

qrcode options may be included when creating the QR code image:

const opts = {
  errorCorrectionLevel: "H",
  rendererOpts: { quality: 0.3 },
};

Example Input/Output:

Logo Image:

QR Code:

License

MIT