QRCodeSDK
Build QR codes with a single TypeScript-first API, then render them in the format your app needs.
Start with your stack
Section titled “Start with your stack”Pick your runtime or framework, install the package, and paste the example.
npm install @qrcodesdk/corepnpm add @qrcodesdk/corevp add @qrcodesdk/coredeno add npm:@qrcodesdk/corebun add @qrcodesdk/coreyarn add @qrcodesdk/coreRender a scalable SVG string with the runtime-neutral Core package:
import {QRCodeSVGRenderer, qrcode} from '@qrcodesdk/core';
const svg = qrcode('https://qrcodesdk.dev').render(QRCodeSVGRenderer());SVG is the recommended default for web pages, print, and static assets. It stays sharp at any size and needs no browser or Node.js APIs. SVG support varies between email clients, so use a PNG Buffer for email.
npm install @qrcodesdk/core @qrcodesdk/browserpnpm add @qrcodesdk/core @qrcodesdk/browservp add @qrcodesdk/core @qrcodesdk/browserdeno add npm:@qrcodesdk/core npm:@qrcodesdk/browserbun add @qrcodesdk/core @qrcodesdk/browseryarn add @qrcodesdk/core @qrcodesdk/browserRender a PNG-backed image element in the browser:
import {QRCodePNGImageRenderer} from '@qrcodesdk/browser/png';import {qrcode} from '@qrcodesdk/core';
const image = qrcode('https://qrcodesdk.dev').render( QRCodePNGImageRenderer({accessibility: {alt: 'QR code: scan to open qrcodesdk.dev'}}),);
document.body.append(image);npm install @qrcodesdk/core @qrcodesdk/nodepnpm add @qrcodesdk/core @qrcodesdk/nodevp add @qrcodesdk/core @qrcodesdk/nodedeno add npm:@qrcodesdk/core npm:@qrcodesdk/nodebun add @qrcodesdk/core @qrcodesdk/nodeyarn add @qrcodesdk/core @qrcodesdk/nodeRender PNG bytes on the server, or WebP, GIF, and JPEG bytes with their renderers:
import {qrcode} from '@qrcodesdk/core';import {QRCodePNGRenderer} from '@qrcodesdk/node';
const png = qrcode('https://qrcodesdk.dev').render(QRCodePNGRenderer());npm install @qrcodesdk/reactpnpm add @qrcodesdk/reactvp add @qrcodesdk/reactdeno add npm:@qrcodesdk/reactbun add @qrcodesdk/reactyarn add @qrcodesdk/reactRender an SVG component in React or Next.js:
import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/react';
const options: QRCodeSVGOptions = {accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'}};
export function App() { return ( <figure> <QRCodeSVG payload="https://qrcodesdk.dev" options={options} /> <figcaption> Scan the code or open <a href="https://qrcodesdk.dev">qrcodesdk.dev</a> </figcaption> </figure> );}npm install @qrcodesdk/vuepnpm add @qrcodesdk/vuevp add @qrcodesdk/vuedeno add npm:@qrcodesdk/vuebun add @qrcodesdk/vueyarn add @qrcodesdk/vueRender an SVG component in Vue:
<script setup lang="ts">import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/vue';
const options: QRCodeSVGOptions = {accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'}};</script>
<template> <figure> <QRCodeSVG payload="https://qrcodesdk.dev" :options="options" /> <figcaption>Scan the code or open <a href="https://qrcodesdk.dev">qrcodesdk.dev</a></figcaption> </figure></template>npm install @qrcodesdk/sveltepnpm add @qrcodesdk/sveltevp add @qrcodesdk/sveltedeno add npm:@qrcodesdk/sveltebun add @qrcodesdk/svelteyarn add @qrcodesdk/svelteRender an SVG component in Svelte:
<script lang="ts"> import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/svelte';
const options: QRCodeSVGOptions = {accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'}};</script>
<figure> <QRCodeSVG payload="https://qrcodesdk.dev" {options} /> <figcaption>Scan the code or open <a href="https://qrcodesdk.dev">qrcodesdk.dev</a></figcaption></figure>npm install @qrcodesdk/angularpnpm add @qrcodesdk/angularvp add @qrcodesdk/angulardeno add npm:@qrcodesdk/angularbun add @qrcodesdk/angularyarn add @qrcodesdk/angularRender a standalone SVG component in Angular:
import {Component} from '@angular/core';import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/angular';
@Component({ selector: 'app-root', imports: [QRCodeSVG], template: ` <figure> <qrcode-svg [options]="options" payload="https://qrcodesdk.dev" /> <figcaption>Scan the code or open <a href="https://qrcodesdk.dev">qrcodesdk.dev</a></figcaption> </figure> `,})export class App { protected readonly options: QRCodeSVGOptions = { accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'}, };}Not sure which package you need? See Choose your setup. For the terminal, start with the CLI.
Next step
Section titled “Next step”- Explore styles visually in the Playground.
- Style your QR code with Customize appearance.
Learn more
Section titled “Learn more”- How QR codes work: modules, patterns, error correction, and masks.
- Compare with other libraries: trade-offs against qrcode, qrcode-generator, and qr-code-styling.
- Troubleshooting: common errors and symptoms.