/qart.js

Generate artistic QR code. 🎨

Primary LanguageJavaScriptGNU General Public License v3.0GPL-3.0

qart.js

Downloads Version License
Merges Pictures and QR Codes for Artistic QR Codes.

Glance At

https://kciter.github.io/qart.js/

Installation

$ npm install qartjs

or clone this repository and copy qart.min.js to your project.

Usage

In the browser

<script src="../dist/qart.min.js"></script>
<script>
	new QArt({
		value: value,
		imagePath: './example.png',
		filter: filter
	}).make(document.getElementById('qart'));
</script>

With ES6

import QArt from 'qartjs';
const qart = new QArt({
	value: value,
	imagePath: './example.png',
	filter: filter
});
qart.make(document.getElementById('qart'));

With React

This is a simple implementation of QArt as React Component. react-qart

With Angular.JS

There is a directive available for using qart.js in Angular.js: angular-qart

Options

Field Type Description Default
value String The data of the QR code. Required
imagePath String The path of the combined image. Required
filter String Define an image filter. threshold or color threshold

Dependency

Inspire

TODO

  • Resize feature.
  • Server-Side Rendering.
  • CLI Command.

LICENSE

GPLv3