Skip to content

Browser download renderers

Use the download renderers inside a browser user action when the SDK should create and click a temporary download link. Use the SVG wrapper for scalable files and the Image wrapper for PNG, WebP, GIF, or JPEG files.

import {QRCodeDownloadSVGRenderer} from '@qrcodesdk/browser';
import {QRCodeSVGRenderer, qrcode} from '@qrcodesdk/core';
qrcode('https://qrcodesdk.dev').render(
QRCodeDownloadSVGRenderer({
renderer: QRCodeSVGRenderer(),
filename: 'qrcode',
}),
);

For a raster file, wrap an Image element renderer with QRCodeDownloadImageRenderer() instead:

import {QRCodeDownloadImageRenderer} from '@qrcodesdk/browser/image';
import {QRCodeWebPImageRenderer} from '@qrcodesdk/browser/webp';
import {qrcode} from '@qrcodesdk/core';
qrcode('https://qrcodesdk.dev').render(
QRCodeDownloadImageRenderer({
renderer: QRCodeWebPImageRenderer(),
filename: 'qrcode',
}),
);

Both wrappers return void. Their effect is a browser download; they do not return the wrapped SVG string or Image element.

Wrapper renderer requirement filename default Added extension
QRCodeDownloadSVGRenderer QRCodeRenderer<string> such as QRCodeSVGRenderer() 'qrcode' .svg
QRCodeDownloadImageRenderer QRCodeRenderer<HTMLImageElement> such as QRCodePNGImageRenderer() 'qrcode' .png, .webp, .gif, or .jpg

The Image wrapper accepts the PNG, WebP, GIF, and JPEG Image element renderers. It picks the extension from the MIME type of the image’s data URL. For any other data URL type, it uses the filename unchanged.

renderer is required. filename is optional; the wrapper appends its extension when the supplied name does not already end with that extension, using a case-insensitive check. A JPEG filename that already ends with .jpeg keeps that extension. Surrounding whitespace is trimmed, and empty or whitespace-only filenames use qrcode. Both factories copy their options when called; changing the original object later does not change the download.

  • Both wrappers require browser DOM download behavior and must be called in a context where the browser permits a programmatic link click.
  • The SVG wrapper creates an image/svg+xml;charset=utf-8 Blob and revokes its object URL 40 seconds after triggering the download, so browsers that start downloads asynchronously can finish reading it.
  • The Image wrapper downloads the wrapped Image element’s existing src; it does not re-encode it.
  • Wrapped renderer options, output validity, and runtime requirements remain the responsibility of the wrapped renderer.

Support QRCodeSDK

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