net-tools/easy-qrcode-js

Composer library for qrcode output

Maintainers

Details

github.com/net-tools/EasyQRCodeJS

Source

Fund package maintenance!
www.easyproject.cn/donation

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 155

Language:JavaScript

4.6.1 2024-03-24 20:03 UTC

MIT 4d1481735eaf3b9efb07ea9cdb8fce748536d2ba

  • https://github.com/ushelp/EasyQRCodeJS
  • Pierre <dev.woop@nettools.ovh>

This package is auto-updated.

Last update: 2024-11-24 21:19:49 UTC

README

EasyQRCodeJS is a powerful, cross-browser QR code generation library that uses JavaScript and runs on DOM-based client browsers. It can be downloaded directly in the browser. It supports Canvas, SVG, and Table drawing methods. It provides flexible configurations, including dot style, Logo, background image, color, title, and support for binary (HEX) data mode. It is also compatible with Angular, Vue.js, React, Next.js, and Svelte frameworks.

EasyQRCodeJS 是使用 JavaScript 的一个强大的、跨浏览器的二维码生成库。运行在基于 DOM 的客户端浏览器，并能够在浏览器中进行下载。它支持Canvas、SVG和Table绘图方法。提供灵活的配置，包括点样式、Logo、背景图片、彩色，标题和二进制（十六进制）数据模式支持。它还能与Angular、Vue.js、React、Next.js和Svelte框架兼容。

Table of contents

Choose what you need

Feature

  • English

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

    • Support unicode character set: 😊❤️👍👨‍💻 Hello, こんにちは, こんにちは, Γεια, Привет, नमस्ते, สวัสดี, Привіт, سلام, Здравей, ສະບາຍດີ, Përshëndetje, Բարեւ, 你好

    • Download the QRCode image in the browser

    • 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

    • Angular, Vue.js, React, Next.js, Svelte Support

    • Support binary(hex) data mode

    • Support TypeScript

  • 中文

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

    • 支持 Unicode 字符集: 😊❤️👍👨‍💻 Hello, こんにちは, こんにちは, Γεια, Привет, नमस्ते, สวัสดี, Привіт, سلام, Здравей, ສະບາຍດີ, Përshëndetje, Բարեւ, 你好

    • 在浏览器中下载

    • 支持点形风格的 Required Patterns

    • 支持 Quiet Zone 设置

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

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

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

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

    • 支持 Background Image 背景图片

    • 支持标题，副标题设置

    • 不依赖任何第三方

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

    • Angular, Vue.js, React, NEXT.js, Svelte 支持

    • 二进制数据模式支持

    • TypeScript 支持

Try It!

Try It!

Demo preview

Demo preview

QR Code Structure

QR Code Structure

Installation

Load

  • Script load

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

  • AMD load

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

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

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

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>

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,
    colorDark : "#000000",
    colorLight : "#ffffff",
    correctLevel : QRCode.CorrectLevel.H, // L, M, Q, H
    
    // ====== dotScale
    /*
    dotScale: 1, // For body block, must be greater than 0, less than or equal to 1. default is 1
    
    dotScaleTiming: 1, // Dafault for timing block , must be greater than 0, less than or equal to 1. default is 1
    dotScaleTiming_H: undefined, // For horizontal timing block, must be greater than 0, less than or equal to 1. default is 1
    dotScaleTiming_V: undefined, // For vertical timing block, must be greater than 0, less than or equal to 1. default is 1
    
    dotScaleA: 1, // Dafault for alignment block, must be greater than 0, less than or equal to 1. default is 1
    dotScaleAO: undefined, // For alignment outer block, must be greater than 0, less than or equal to 1. default is 1
    dotScaleAI: undefined, // For alignment inner block, must be greater than 0, less than or equal to 1. default is 1
    */
   
    // ====== Quiet Zone
    /*
    quietZone: 0,
    quietZoneColor: "rgba(0,0,0,0)",
    */

    // ====== 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, // fixed logo width. default is `width/3.5`
    logoHeight: 80, // fixed logo height. default is `heigth/3.5`
    logoMaxWidth: undefined, // Maximum logo width. if set will ignore `logoWidth` value
    logoMaxHeight: undefined, // Maximum logo height. if set will ignore `logoHeight` value
    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, // Automatic color adjustment(for data block)
    autoColorDark: "rgba(0, 0, 0, .6)", // Automatic color: dark CSS color
    autoColorLight: "rgba(255, 255, 255, .7)", // Automatic color: light CSS color
    */
    
    // ====== 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: "normal normal 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: "normal normal normal 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,
    onRenderingEnd: undefined,
    */
   
    // ===== Versions
    /*
    version: 0, // The symbol versions of QR Code range from Version 1 to Version 40. default 0 means automatically choose the closest version based on the text length.
    */     
   
    // ===== Binary(hex) data mode
    /*
    binary: false, // Whether it is binary mode, default is text mode. 
    */ 
    
    // ===== Tooltip
    /*
    tooltip: false, // Whether set the QRCode Text as the title attribute value of the QRCode div
    */
   
    // ==== CORS
    /*
    crossOrigin: null, // String which specifies the CORS setting to use when retrieving the image. null means that the crossOrigin attribute is not set.
    */
   
    // =====  Drawing method
    /*
    drawer: 'canvas', // Which drawing method to use. 'canvas', 'svg'. default is 'canvas'
    */   
   
    // =====  UTF-8 without BOM
    /*
    utf8WithoutBOM: true
    */   

}

Method

  • clear()

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

  • makeCode(text)

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

  • resize(width, height)

     qrcode.resize(480, 480); // Resize the image

  • download(fileName)

     qrcode.download("easyQRCode"); // Download the image or svg file, the filename does not need to include extension, '.png' or '.svg' suffix will be added automatically

Download the QRCode Image in the Browser

For a long time, I have not been included to add a download function to our features, because due to browser environment restrictions, it cannot guarantee to truly fully output the image seen by the user.

On the other hand, I see many user demands related to downloading, and there are also different implementation methods, so I decide to provide a friendly and as fully-featured download implementation as possiable.

However, saving Canvas or SVG images on the client side is subject to many restrictions in the browser environments. For example, if your EasyQRCode image used an external image and there is a cross domain issue, you may be able to see the exernal image in the browser, but actully these images may not be able to be read normally and saved to your download file.

Therefore, if your requirement is to save the QRCode as an image, you may consider using EasyQRCodeJS-NodeJS on the server side to gain more complete control.

<!-- QRCode -->
<div id="qrcode"></div>
<!-- Download button -->
<button id="qrcode_download" onclick="downloadQRcode()" style="display:none">download</button>


<script type="text/javascript">
    var config = {
        text: "www.easyproject.cn/donation",
        //...
        onRenderingEnd:function(options, dataURL){
            // Display your download button after the EasyQRCode is rendered.
            document.getElementById("qrcode_download").style.display='block';
        }
    }
    // Initiate EasyQRCode 
    var qrcode = new QRCode(document.getElementById("qrcode"), config);

    function downloadQRcode(){
         // Download the png image or svg file
         // The '.png' or '.svg' suffix will be added to filename automatically 
         var fileName = 'EasyQRCode-file'
         qrcode.download(fileName);   
    }
</script>

Angular Support

  1. Add dependency

    # install with `npm`
npm install --save easyqrcodejs

# Alternatively you may use `yarn`:
yarn add easyqrcodejs

  2. [NAME].component.html

    <!-- DOM Element-->
<div #qrcode></div>

  3. Activate esModuleInterop in your tsconfig.json

    "esModuleInterop": true,

  4. [NAME].component.ts

    import { Component, AfterViewInit, ElementRef, ViewChild } from '@angular/core';
import QRCode from 'easyqrcodejs';

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent implements AfterViewInit{
    
  // Your DOM Element
  @ViewChild('qrcode', {static: false}) qrcode: ElementRef;

  ngAfterViewInit(){

    // Options
    var options = {
      text: "https://github.com/ushelp/EasyQRCodeJS"
    }

    // Create new QRCode Object
    new QRCode(this.qrcode.nativeElement, options);

  }

  btnClick(){
    // ....
  }

}

Vue.js Support

  1. Add dependency

    # install with `npm`
npm install --save easyqrcodejs

# Alternatively you may use `yarn`:
yarn add easyqrcodejs

  2. Template

    <!-- DOM Element-->
<div ref="qrcode"></div>

  3. Script

    <script>
import * as QRCode from 'easyqrcodejs'   
 
export default {

  mounted(){
    // Options
    var options = {
      text: "https://github.com/ushelp/EasyQRCodeJS"
    }
    
    // Create new QRCode Object
    new QRCode(this.$refs.qrcode, options);
  },
  methods:{
      btnClick(){

      }
  }
}
</script>

React Support

  1. Add dependency

    # install with `npm`
npm install --save easyqrcodejs

# Alternatively you may use `yarn`:
yarn add easyqrcodejs

  2. Script

    • JavaScript

      import React from 'react';
import './App.css';
import * as QRCode from 'easyqrcodejs';

class App extends React.Component {

    constructor(props) {
        super(props);
        this.qrcode = React.createRef();
    }

    componentDidMount() {
        // Options
        var options = {
            text: "https://github.com/ushelp/EasyQRCodeJS"
        }
        // Create new QRCode Object
        new QRCode( this.qrcode.current, options);
    }
    render() {
        return ( 
        <div className = "App">
            <div ref={this.qrcode}></div> 
        </div>
        );
    }
}

export default App;

    • TypeScript

      import React, { useEffect } from "react";
import QRCode from "easyqrcodejs";

function App() {
  const code = React.createRef<HTMLDivElement>();

  useEffect(() => {
    new QRCode(code.current, { text: "https://github.com/ushelp/EasyQRCodeJS" });
  }, [code]);

  return (
    <div className="App">
      <header className="App-header">
     
        <div ref={code}></div>
      </header>
    </div>
  );
}

export default App;

Next.js Support

  1. Add dependency

    Add easy.qrcode.min.js to your static files folder called static(<Next.js 9.1)/public(>=Next.js 9.1) in the root directory.

  2. Script

    import Layout from '../components/Layout';
// Import Head
import Head from "next/head";

class About extends React.Component {
  constructor(props) {
    super(props);
    // QRCode DOM
    this.qrcodeDOM = React.createRef();
    // QRCode
    this.qrcode=null;
  }
  
  //QRCode generator
  generate(color){
      if(this.qrcode){
          this.qrcode.clear();
      }
      var options = {
          text: "https://github.com/ushelp/EasyQRCodeJS",
          colorDark : color?color:'#000000'
      };
      this.qrcode=new QRCode(this.qrcodeDOM.current, options);
  }
  
  // Gerenate QRCode on mount
  componentDidMount() { 
       this.generate()
  }
  
  render() {
    return (
      <Layout>
          <p>This is About page</p>
          {/* DOM */}
          <div ref={this.qrcodeDOM}></div>
          {/* Gerenate QRCode on click */}
          <button onClick={this.generate.bind(this, '#ff0000')}>QRCode Generate</button>
          {/* Include EasyQRCodeJS library*/}
          <Head>
           <script type="text/javascript" src="/public/easy.qrcode.min.js"></script>
         </Head>
           <p>This is About page</p>
      </Layout>
    );
  }
}

export default About;

Svelte Support

  1. Add dependency

    # install with `npm`
npm install --save-dev easyqrcodejs

# Alternatively you may use `yarn`:
yarn add easyqrcodejs --dev

  2. Component template

    QR.svelte:

    <script>
 import { onMount } from 'svelte';
 import QRCode from 'easyqrcodejs'
 // import * as QRCode from 'easyqrcodejs';

  export let codeValue;
  let node;

  onMount(() => {
    const options = {
      text: codeValue,
      // ... your other options
      width: 100,
      height: 100,
      quietZone: 10,
    };
    new QRCode(node, options);
  });
</script>

<div bind:this={node}></div>

<style>
 div {
   /* make QR-wrapper squared */
    width: 100%;
    position: relative;
    padding: 50%;
    z-index: 1;
  }
  div :global(canvas) {
    /* fit QR to wrapper */
    width: 100%;
    height: 100%;
    position: absolute;
    left: 0;
    top: 0;
  }
</style>

  3. Layout

    index.svelte:

    <script>
  import QR from './QR.svelte';
</script>

<div class="qr-container">
  <QR text="Your awesome text here..." />
</div>

<style>
  .qr-container {
    /* your styles for container here */
  }
</style>

FQA

Q1. Tainted canvases may not be exported.

When use canvas drawer, Canvas toDataURL function does not allow load cross domain image. there are three options to slove this problem:

  • Option 1:

    Configure the crossOrigin attribute(crossorigin) for the image. Make sure that CORS is configured on the Server side.

    {
   // ...
 
   // String which specifies the CORS setting to use when retrieving the image. null means that the crossOrigin attribute is not set. 'anonymous', null.
   crossOrigin : 'anonymous',
 
   // ... 
}

  • Option 2:

    Put your image under the same domain with your page.

  • Option 3:

    Use base64 image.

Q2. How to show the QRCode image only after rendering is done?

onRenderingStart: function(qrCodeOptions) {
    qrCodeOptions._element.style.display = 'none';
},
onRenderingEnd: function(qrCodeOptions) {
    qrCodeOptions._element.style.display = 'block';
},

Browser Compatibility

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

License

MIT License

EasyQRCodeJS-Premium

Let you draw freely!

EasyQRCodeJS-Premium is a more powerful and comprehensive enterprise version. You can use Canvas to customize any element, such as eye frame shape, eyeball shape, QR code block shape, and more. Also supports excavation (to prevent the QRcode overlap with the logo), random block mode.

If you need more functions, we can provide you with customized development of API libraries or products. please contact me to buy the business enterprise edition.

EasyQRCodeJS-Premium 是功能更加强大和全面的商业/企业版本。让您可以在 QRCode 中通过 Canvas 自定义任何喜欢的元素，例如 Eye frame 形状, Eye ball 形状, QR Body block 形状等等。 还支持 Logo 挖取（excavation，防止二维码与 Logo 重叠）和 Random bolock mode.

如果您需要更多功能，我们可以为您提供 API 库或产品的定制开发。请联系我购买商业/企业版本。

Premium demo preview

End

Email：inthinkcolor@gmail.com

http://www.easyproject.cn

Donation/捐助:

支付宝/微信/QQ/云闪付/PayPal 扫码支付 支付宝/微信/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.