Skip to content

@qrcodesdk/browser

@qrcodesdk/browser adds renderers that need browser DOM APIs. Use it with @qrcodesdk/core to create Canvas and Image elements and to download files.

Terminal window
npm install @qrcodesdk/core @qrcodesdk/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);

The result is an HTMLImageElement with a PNG data URL as its src. Its width and height match the QR code size. The WebP, GIF, and JPEG renderers take the same options.

See Render QR codes in the browser to insert and replace browser output.

Need Renderer Return value
Insert a PNG-backed image QRCodePNGImageRenderer HTMLImageElement
Insert a smaller WebP image QRCodeWebPImageRenderer HTMLImageElement
Insert a GIF image QRCodeGIFImageRenderer HTMLImageElement
Insert a JPEG image QRCodeJPEGImageRenderer HTMLImageElement
Draw or export with Canvas APIs QRCodeCanvasRenderer HTMLCanvasElement
Trigger an SVG download QRCodeDownloadSVGRenderer void
Trigger a PNG, WebP, GIF, or JPEG download QRCodeDownloadImageRenderer void

Which image format?

  • PNG is the default. It uses the browser’s native encoder.
  • WebP is lossless and usually the smallest. QRCodeSDK bundles its encoder, so it also works in Safari, which cannot encode WebP natively.
  • GIF has at most 256 colors and on-or-off transparency. Prefer PNG or WebP for transparent backgrounds and photo center images.
  • JPEG is lossy, has no transparency, and is larger for plain QR codes. Use it only when a destination requires JPEG.

The bundled WebP encoder reads pixels the browser draws on a Canvas. Bytes therefore match across browsers only when their Canvas pixels match.

The bundled JPEG encoder blends transparent pixels onto white. Browsers’ native JPEG encoding uses black.

Each output has its own reference for options and browser constraints:

Related guides:

Each image format has its own entry point. Importing one renderer loads only that format’s encoder.

Entry point Exports
@qrcodesdk/browser/png QRCodePNGImageRenderer
@qrcodesdk/browser/webp QRCodeWebPImageRenderer
@qrcodesdk/browser/gif QRCodeGIFImageRenderer
@qrcodesdk/browser/jpeg QRCodeJPEGImageRenderer
@qrcodesdk/browser/image QRCodeDownloadImageRenderer and shared Image element option types
@qrcodesdk/browser/canvas QRCodeCanvasRenderer and canvasCenterImage()
@qrcodesdk/browser/svg QRCodeDownloadSVGRenderer
  • The root @qrcodesdk/browser entry point re-exports everything. Bundlers with tree shaking drop the encoders you do not use. Without tree shaking, import from the format entry points.
  • The package imports @qrcodesdk/core by its package name. Load it through a bundler or another tool that resolves package names.

Create these renderers only where document, Canvas, and browser download APIs exist.

  • Server rendering: create them after hydration, or use the SVG renderer from @qrcodesdk/core.
  • PNG, WebP, GIF, or JPEG bytes without a DOM: use @qrcodesdk/node.
import {
type QRCodeCanvasAccessibilityOptions,
type QRCodeCanvasCenterImage,
type QRCodeCanvasOptions,
QRCodeCanvasRenderer,
type QRCodeCanvasRendererOptions,
QRCodeDownloadImageRenderer,
type QRCodeDownloadImageRendererOptions,
QRCodeDownloadSVGRenderer,
type QRCodeDownloadSVGRendererOptions,
type QRCodeGIFImageOptions,
QRCodeGIFImageRenderer,
type QRCodeGIFImageRendererOptions,
type QRCodeImageAccessibilityOptions,
type QRCodeImageRendererOptions,
type QRCodeJPEGImageOptions,
QRCodeJPEGImageRenderer,
type QRCodeJPEGImageRendererOptions,
type QRCodePNGImageOptions,
QRCodePNGImageRenderer,
type QRCodePNGImageRendererOptions,
type QRCodeWebPImageOptions,
QRCodeWebPImageRenderer,
type QRCodeWebPImageRendererOptions,
canvasCenterImage,
} from '@qrcodesdk/browser';

@qrcodesdk/browser

Version
v0.0.6
Downloads
1.1K/mo
Install size
58.7 kB
Bundled size
10.5 kB
Works with
Works with Google ChromeWorks with FirefoxWorks with Safari

Support QRCodeSDK

If you find QRCodeSDK useful, please consider sponsoring the project!