Skip to content

heartnetkung/node-fancy-qr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Fancy QR

Create QR code with logo or a change of color. The data capacity is up to ~1200 bytes. Here is the example of your output:

alt text alt text

Installation

npm install fancyqr

Then, read how to install native dependency here.

Usage

var fancyQR = require('fancyqr');
fancyQR.save(__dirname + '/out.png', 'hello world!', {
	r: 237,
	g: 127,
	b: 38,
	logoPath: __dirname + '/logo.png'
}, function(err) {
	//do something here
});

API

//save the image output as png
fancyQR.save(pngOutputPath,text,options,callback(err));

//output as data url
fancyQR.toDataURL(text,options,callback(err,urlString));

//output as internal canvas object for further modification (see API from node-canvas)
fancyQR.draw(text,options,callback(err,canvasObject));

Options can have the following fields:

  • r: red color of the qr output (logo unaffected) [0-255]
  • g: green color [0-255]
  • b: blue color [0-255]
  • logoPath: path of the logo, recommended 30 x 30 or smaller

About

Create QR code with logo or a change of color.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published