Renderer outputs
Renderers convert the same QRCodeMatrix into different output values. Choose by the value your
application needs, then install its package.
| Output | Renderer | Return type | Package | Runtime | Best use case |
|---|---|---|---|---|---|
| SVG string | QRCodeSVGRenderer |
string |
@qrcodesdk/core |
Any Core-compatible runtime | Scalable web, email, print, and server output |
| Terminal text | QRCodeTextRenderer |
string |
@qrcodesdk/core |
UTF-8 text environment | Terminals, logs, CLIs, and snapshots |
| Canvas element | QRCodeCanvasRenderer |
HTMLCanvasElement |
@qrcodesdk/browser |
Browser DOM | Drawing, compositing, and manual raster export |
| PNG-backed Image element | QRCodePNGImageRenderer |
HTMLImageElement |
@qrcodesdk/browser |
Browser DOM | Accessible DOM image and CSS workflows |
| WebP-backed Image element | QRCodeWebPImageRenderer |
HTMLImageElement |
@qrcodesdk/browser |
Browser DOM | Smallest lossless DOM image |
| GIF-backed Image element | QRCodeGIFImageRenderer |
HTMLImageElement |
@qrcodesdk/browser |
Browser DOM | Destinations that require GIF |
| JPEG-backed Image element | QRCodeJPEGImageRenderer |
HTMLImageElement |
@qrcodesdk/browser |
Browser DOM | Destinations that require JPEG |
| SVG browser download | QRCodeDownloadSVGRenderer |
void |
@qrcodesdk/browser |
Browser DOM | User-triggered scalable file download |
| Image browser download | QRCodeDownloadImageRenderer |
void |
@qrcodesdk/browser |
Browser DOM | User-triggered PNG, WebP, GIF, or JPEG file download |
| PNG Buffer | QRCodePNGRenderer |
Buffer |
@qrcodesdk/node |
Node.js-compatible runtime | Files, HTTP responses, and attachments |
| WebP Buffer | QRCodeWebPRenderer |
Buffer |
@qrcodesdk/node |
Node.js-compatible runtime | Smallest lossless raster files and responses |
| GIF Buffer | QRCodeGIFRenderer |
Buffer |
@qrcodesdk/node |
Node.js-compatible runtime | Destinations that require GIF |
| JPEG Buffer | QRCodeJPEGRenderer |
Buffer |
@qrcodesdk/node |
Node.js-compatible runtime | Destinations that require JPEG, photo center images |
Framework packages wrap the same output families in components: see React and Next.js, Vue, Svelte, or Angular. To produce another return type, implement the Custom renderers reference.
Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!