Browser download renderers
When to use
Section titled “When to use”Use a download renderer inside a browser user action. The SDK creates and clicks a temporary download link for you.
QRCodeDownloadSVGRendererdownloads a scalable SVG file.QRCodeDownloadImageRendererdownloads a PNG, WebP, GIF, or JPEG file.
Minimal example
Section titled “Minimal example”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():
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', }),);Return value
Section titled “Return value”Both wrappers return void. They start a browser download and do not return the SVG string or
Image element.
Options
Section titled “Options”| Wrapper | renderer (required) |
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 type, it keeps the filename unchanged.
Filenames
Section titled “Filenames”- Surrounding whitespace is trimmed.
- Empty or whitespace-only names become
qrcode. - The extension is appended unless the name already ends with it, compared case-insensitively.
- A JPEG filename that already ends with
.jpegkeeps that extension.
Constraints
Section titled “Constraints”- User action. Both wrappers need browser DOM download behavior. Call them where the browser allows a programmatic link click.
- SVG Blob. The SVG wrapper creates an
image/svg+xml;charset=utf-8Blob. It revokes the object URL 40 seconds after the download starts, so browsers that download asynchronously can finish. - No re-encoding. The Image wrapper downloads the Image element’s existing
srcas is. - No checks of the wrapped renderer. The wrappers do not validate its options, output, or runtime requirements.
- Option copies. Both factories copy their options when they are called. Later changes to the original object do not affect the download.
Related guides
Section titled “Related guides”- Download or save for choosing a format and for framework component, Canvas, and Node.js workflows.
- SVG string renderer and Image element renderers for the wrapped options.
Related pages
Section titled “Related pages”Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!