uqr

Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG.

QR code
unjs/uqruqr

README

uqr


Generate QR Code universally, in any runtime, to ANSI, Unicode or SVG. ES module , zero dependency, tree-shakable.

Install


  1. ```bash
  2. # Using npm
  3. npm install uqr

  5. # Using yarn
  6. yarn add uqr

  8. # Using pnpm
  9. pnpm add uqr
  10. ```

Usage


  1. ```ts
  2. import {
  3.   encode,
  4.   renderANSI,
  5.   renderSVG,
  6.   renderUnicode,
  7.   renderUnicodeCompact,
  8. } from 'uqr'

  10. const svg = renderSVG('Hello, World!')

  12. const ansi = renderANSI('https://192.168.1.100:3000', {
  13.   // Error correction level
  14.   ecc: 'L',
  15.   // Border width
  16.   border: 2,
  17. })

  19. // display QR Code in terminal
  20. console.log(ansi)
  21. ```

API


encode


Encode plain text or binary data into QR Code represented by a 2D array.

  1. ```ts
  2. import { encode } from 'uqr'

  4. const {
  5.   data, // 2D array of boolean, representing the QR Code
  6.   version, // QR Code version
  7.   size, // size of the QR Code
  8. } = encode(text, options)
  9. ```

renderANSI


Render QR Code to ANSI colored string.

  1. ```ts
  2. import { renderANSI } from 'uqr'

  4. const string = renderANSI(text, options)

  6. console.log(string)
  7. ```

renderUnicode


Render QR Code to Unicode string for each pixel. By default it uses █ and ░ to represent black and white pixels, and it can be customizable.

  1. ```ts
  2. import { renderUnicode } from 'uqr'

  4. const string = renderUnicode(text, {
  5.   blackChar: '█',
  6.   whiteChar: '░',
  7.   // ...other options
  8. })
  9. ```

renderUnicodeCompact


Render QR Code with two rows into one line with unicode ▀, ▄, █, . It is useful when you want to display QR Code in terminal with limited height.

  1. ```ts
  2. import { renderUnicodeCompact } from 'uqr'

  4. const string = renderUnicodeCompact(text, options)

  6. console.log(string)
  7. ```

renderSVG


Render QR Code to SVG string.

  1. ```ts
  2. import { renderSVG } from 'uqr'

  4. const string = renderSVG(text, options)
  5. ```

Credits


QR Code generation algorithm is modified from nayuki/QR-Code-generator by Project Nayuki.

CLI renders are inspired by qrcode-terminal.