EasyQRCodeJS

EasyQRCodeJS is a feature-rich cross-browser pure JavaScript QRCode generation library. Support for Javascript modules. Support setting Dot style, Logo, Background image, Colorful, Title and more.

EasyQRCodeJS 是一个功能丰富的跨浏览器的纯 JavaScript QRCode 生成库。支持 JavaScript 模块化加载。支持点状风格，Logo，背景图片，规则色彩控制，标题等设置。

Choose what you need

Project	Support
EasyQRCodeJS	Running with DOM on CLIENT-SIDE . Browser(IE6+, Chrome, Firefox, Safari, Opera, Mobile Safari, Android, Windows Mobile, ETC.), Electron, NW.js, ETC.
EasyQRCodeJS-NodeJS	Running without DOM on SERVER-SIDE. Save image to file or get data url text. NodeJS, Electron, NW.js, ETC.

Feature

• English

  • Cross-browser support for QR code generation based on HTML5 Canvas and Table

  • Required Patterns that support dot style

  • Support for Quiet Zone settings

  • Support custom Position Pattern inner fill and outer border color

  • Support custom Alignment Pattern inner fill and outer border color

  • Support custom Timing Patterns vertical, horizontal color

  • Support Logo images (including transparent PNG images)

  • Support Background Image

  • Support for title, subtitle settings

  • Has no dependencies

  • Support AMD, CMD, CommonJS/Node.js JavaScript modules

• 中文

  • 跨浏览器，支持基于 HTML5 Canvas 和 Table 的二维码生成

  • 支持点形风格的 Required Patterns

  • 支持 Quiet Zone 设置

  • 支持自定义 Position Pattern 内填充和外边框颜色

  • 支持自定义 Alignment Pattern 内填充和外边框颜色

  • 支持自定义 Timing Patterns 垂直，水平颜色

  • 支持 Logo 图片（包括背景透明的 PNG 图片）

  • 支持 Background Image 背景图片

  • 支持标题，副标题设置

  • 不依赖任何第三方

  • 支持 AMD，CMD, CommonJS/Node.js JavaScript 模块加载规范

Try It!

Try It!

Demo preview

QR Code Structure

Installation

• Download install

   <script src="dist/easy.qrcode.min.js" type="text/javascript" charset="utf-8"></script>
   

• Npm install

   npm install easyqrcodejs

Basic Usages

<div id="qrcode"></div>

<script type="text/javascript">
	// Options
	var options = {
		text: "https://github.com/ushelp/EasyQRCodeJS"
	};
	
	// Create QRCode Object
	new QRCode(document.getElementById("qrcode"), options);
</script>

• AMD load

   require.config({
   	paths: {
   		QRCode: "<YOUR_PATH>/easy.qrcode.min"
   	}
   });
   
   require(["QRCode"], function(QRCode){
   	
   	// Your code...
   	
   });

• Node.js load(For Example, Use in Electron)

   const QRCode = require('easyqrcodejs');
   
   // Your code...

QRCode API

Object

var qrcode = new QRCode(DOM_object, options_object);

• Options

    var options_object = {
   		// ====== Basic
   		text: "https://github.com/ushelp/EasyQRCodeJS",
   		width: 256,
   		height: 256,
   		quietZone: 0,
   		colorDark : "#000000",
   		colorLight : "#ffffff",
   		correctLevel : QRCode.CorrectLevel.H, // L, M, Q, H
   		dotScale: 1 // Must be greater than 0, less than or equal to 1. default is 1
   		
   		// ====== Logo
   		/*
   		logo:"../demo/logo.png", // Relative address, relative to `easy.qrcode.min.js`
   		logo:"http://127.0.0.1:8020/easy-qrcodejs/demo/logo.png", 
   		logoWidth:80, // widht. default is automatic width
   		logoHeight:80 // height. default is automatic height
   		logoBackgroundColor:'#fffff', // Logo backgroud color, Invalid when `logBgTransparent` is true; default is '#ffffff'
   		logoBackgroundTransparent:false, // Whether use transparent image, default is false
   		*/
   	
   		// ====== Backgroud Image
   		/*
   		backgroundImage: '', // Background Image
   		backgroundImageAlpha: 1, // Background image transparency, value between 0 and 1. default is 1. 
   		autoColor: false,
   		*/
   		
   		// ====== Colorful
   		// === Posotion Pattern(Eye) Color
   		/*
   		PO: '#e1622f', // Global Posotion Outer color. if not set, the defaut is `colorDark`
   		PI: '#aa5b71', // Global Posotion Inner color. if not set, the defaut is `colorDark`
   		PO_TL:'', // Posotion Outer color - Top Left 
   		PI_TL:'', // Posotion Inner color - Top Left 
   		PO_TR:'', // Posotion Outer color - Top Right 
   		PI_TR:'', // Posotion Inner color - Top Right 
   		PO_BL:'', // Posotion Outer color - Bottom Left 
   		PI_BL:'', // Posotion Inner color - Bottom Left 
   		*/
   		// === Alignment Color
   		/*
   		AO: '', // Alignment Outer. if not set, the defaut is `colorDark`
   		AI: '', // Alignment Inner. if not set, the defaut is `colorDark`
   		*/
   		// === Timing Pattern Color
   		/*
   		timing: '#e1622f', // Global Timing color. if not set, the defaut is `colorDark`
   		timing_H: '', // Horizontal timing color
   		timing_V: '', // Vertical timing color
   		*/
   		
   		// ====== Title
   		/*
   		title: 'QR Title', // content 
   		titleFont: "bold 18px Arial", //font. default is "bold 16px Arial"
   		titleColor: "#004284", // color. default is "#000"
   		titleBackgroundColor: "#fff", // background color. default is "#fff"
   		titleHeight: 70, // height, including subTitle. default is 0
   		titleTop: 25, // draws y coordinates. default is 30
   		*/
   	   
   		// ====== SubTitle
   		/*
   		subTitle: 'QR subTitle', // content
   		subTitleFont: "14px Arial", // font. default is "14px Arial"
   		subTitleColor: "#004284", // color. default is "4F4F4F"
   		subTitleTop: 40, // draws y coordinates. default is 0
   		*/
   	   
   		// ===== Event Handler
   		/*
   		onRenderingStart: undefined
   		*/
   }

  Option	Required	Type	Defaults	Description	Compatibility
  Basic options	---	---	---	---	---
  text	Y	String	''	Text
  width	N	Number	256	Width
  height	N	Number	256	Height
  quietZone	N	Number	0	Quiet Zone size
  colorDark	N	String	#000000	Dark CSS color
  colorLight	N	String	#ffffff	Light CSS color
  correctLevel	N	Enum	QRCode.CorrectLevel.H	QRCode.CorrectLevel.H QRCode.CorrectLevel.Q QRCode.CorrectLevel.M QRCode.CorrectLevel.L
  dotScale	N	Number	1.0	Dot style required Patterns. Ranges: 0-1.0
  Logo options	---	---	---	---	---
  logo	N	String	undefined	Logo Image Path. If use relative address, relative to easy.qrcode.min.js
  logoWidth	N	Number	undefined	Height
  logoHeight	N	Number	undefined	Width
  logoBackgroundTransparent	N	Boolean	false	Whether the background transparent image(PNG) shows transparency. When true, logoBackgroundColor is invalid
  logoBackgroundColor	N	String	#ffffff	Set Background CSS Color when image background transparent. Valid when logoBackgroundTransparent is false
  Backgroud Image options	---	---	---	---	---
  backgroundImage	N	String	undefined	Background Image Path. If use relative address, relative to easy.qrcode.min.js
  backgroundImageAlpha	N	Number	1.0	Background image transparency. Ranges: 0-1.0
  autoColor	N	Boolean	false	Automatic color adjustment
  Posotion Pattern Color options	---	---	---	---	---
  PO	N	String	undefined	Global Posotion Outer CSS color. if not set, the defaut is colorDark
  PI	N	String	undefined	Global Posotion Inner CSS color. if not set, the defaut is colorDark
  PO_TL	N	String	undefined	Posotion Outer CSS color - Top Left
  PI_TL	N	String	undefined	Posotion Inner CSS color - Top Left
  PO_TR	N	String	undefined	Posotion Outer CSS color - Top Right
  PI_TR	N	String	undefined	Posotion Inner CSS color - Top Right
  PO_BL	N	String	undefined	Posotion Outer CSS color - Bottom Left
  PI_BL	N	String	undefined	Posotion Inner CSS color - Bottom Left
  Alignment Color options	---	---	---	---	---
  AO	N	String	undefined	Alignment Outer CSS color. if not set, the defaut is colorDark
  AI	N	String	undefined	Alignment Inner CSS color. if not set, the defaut is colorDark
  Timing Pattern Color options	---	---	---	---	---
  timing	N	String	undefined	Global Timing CSS color. if not set, the defaut is colorDark
  timing_H	N	String	undefined	Horizontal timing CSS color
  timing_V	N	String	undefined	Vertical timing CSS color
  Title options	---	---	---	---	---
  title	N	String	''
  titleFont	N	String	bold 16px Arial	CSS Font
  titleColor	N	String	#000000	CSS color
  titleBackgroundColor	N	String	#ffffff	CSS color
  titleHeight	N	Number	0	Title Height, Include subTitle
  titleTop	N	Number	30	draws y coordinates.
  SubTitle options	---	---	---	---	---
  subTitle	N	String	''
  subTitleFont	N	String	14px Arial	CSS Font
  subTitleColor	N	String	#4F4F4F	CSS color
  subTitleTop	N	Number	0	draws y coordinates. default is 0
  Event Handler options	---	---	---	---	---
  onRenderingStart	N	Function	undefined	Callback function when rendering start work. can use to hide loading state or handling.

Method

• clear()

   qrcode.clear(); // remove the code.

• makeCode(text)

   qrcode.makeCode("https://github.com/ushelp/EasyQRCodeJS"); // make another code text.

Browser Compatibility

IE6+, Chrome, Firefox, Safari, Opera, Mobile Safari, Android, Windows Mobile, ETC.

License

MIT License

End

Email：[email protected]

http://www.easyproject.cn

Donation/捐助:

支付宝/微信/QQ/云闪付/PayPal

我们相信，每个人的点滴贡献，都将是推动产生更多、更好免费开源产品的一大步。

感谢慷慨捐助，以支持服务器运行和鼓励更多社区成员。

We believe that the contribution of each bit by bit, will be driven to produce more and better free and open source products a big step.

Thank you donation to support the server running and encourage more community members.