Skip to content

Automaticly generate your styled QR code in your deno web app.

License

Notifications You must be signed in to change notification settings

hironichu/styled-qr-code-deno

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QR Code Styling

JavaScript library for generating QR codes with a logo and styling.

This is a Deno fork of the QR code styling repo qr-code-styling, supporting NodeJs as well as svg exports. If you are looking for browser support head to the original project

Try it here https://qr-code-styling.com

If you have issues / suggestions / notes / questions, please open an issue or contact me. Let's create a cool library together.

Examples

Usage

import {QRCodeCanvas} from '@loskir/styled-qr-code-node';
const {QRCodeCanvas} = require('@loskir/styled-qr-code-node'); // or CommonJS

const qrCode = new QRCodeCanvas({
  data: 'My text or trl',
  image: 'pathToImage'
});

//"png" | "jpg" | "jpeg" | "pdf" | "svg"
await qrCode.toFile('output.png', 'png');

API Documentation

Styling options

Please refer to the original

Export methods

qrCode.toFile(options) => Promise<void>

Param Type Default Value Description
filePath string the path where the image will be saved
format string ("png" / "jpg" / "jpeg" / "pdf" / "svg") 'png' File format
options skia-canvas RenderOptions undefined see doc

qrCode.totoDataUrl(options) => Promise<string>

Param Type Default Value Description
format string ("png" / "jpg" / "jpeg" / "pdf" / "svg") 'png' File format
options skia-canvas RenderOptions undefined see doc

qrCode.toBuffer(options) => Promise<Buffer>

Param Type Default Value Description
format string ("png" / "jpg" / "jpeg" / "pdf" / "svg") 'png' File format
options skia-canvas RenderOptions undefined see doc

About

Automaticly generate your styled QR code in your deno web app.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 93.7%
  • JavaScript 6.3%