qart.js

Generate artistic QR code. ?

Github stars Tracking Chart

Glance At

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

Installation

NPM

$ npm install qartjs

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

CDN

<script src="//cdnjs.cloudflare.com/ajax/libs/qartjs/1.0.2/qart.min.js"></script>

Usage

In the browser

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

	// using callback
	new QArt({
      value: value,
      imagePath: './example.png',
      filter: filter,
      size: 195
  	}).make(function (canvas) {
  	  document.getElementById('qart').appendChild(canvas)
  	});
</script>

With ES6

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

// directly appending canvas to the document
qart.make(document.getElementById('qart'))

// using callback
qart.make((canvas) => {
  document.getElementById('qart').appendChild(canvas);
});

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

With Vue 2.x

There is a directive available for using qart.js in Vue.js 2.x : vue-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, size, Integer, Define an image size in pixels., 195, version, Integer, QRCode version (1 <= version <= 40), 10, background, CSSColor, Implement background if exist, undefinded, fillType, scale_to_fit/fill, Place image type(fill or scale to fit), scale_to_fit

Dependency

Inspire

TODO

  • Server-Side Rendering.
  • CLI Command.

If you like this open source, you can sponsor it. :smile:

Paypal me

LICENSE

GPLv3

Main metrics

Overview
Name With Ownerkciter/qart.js
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 2)
Platform
License:GNU General Public License v3.0
所有者活动
Created At2017-01-25 12:10:14
Pushed At2023-09-02 10:50:29
Last Commit At2023-06-26 17:35:50
Release Count4
Last Release Name1.2.0 (Posted on )
First Release Name1.0.1 (Posted on )
用户参与
Stargazers Count3.2k
Watchers Count75
Fork Count177
Commits Count93
Has Issues Enabled
Issues Count24
Issue Open Count8
Pull Requests Count15
Pull Requests Open Count0
Pull Requests Close Count1
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private