Skip to content
QRCodeSDK
ALPHA

Choose your setup

Choose the smallest package set that produces the output your application needs. Core is the default when SVG or terminal text is enough; renderer and framework packages build on it.

Choose a package

Section titled “Choose a package”
Package Choose it for Outputs
@qrcodesdk/core Runtime-neutral generation and raw matrix access SVG string, terminal text string, QRCodeMatrix
@qrcodesdk/browser Direct DOM output and client-side downloads HTMLCanvasElement, PNG-backed HTMLImageElement, SVG or PNG download
@qrcodesdk/node Server-side raster output PNG Buffer
@qrcodesdk/react React and Next.js components QRCodeSVG, QRCodeImage, QRCodeCanvas, SVG or PNG download
@qrcodesdk/vue Vue components QRCodeSVG, QRCodeImage, QRCodeCanvas, SVG or PNG download
@qrcodesdk/svelte Svelte components QRCodeSVG, QRCodeImage, QRCodeCanvas, SVG or PNG download
@qrcodesdk/angular Standalone Angular components QRCodeSVG, QRCodeImage, QRCodeCanvas, SVG or PNG download
@qrcodesdk/cli Terminal, shell, and CI workflows Terminal text, SVG file, PNG file

For an output-first comparison with exact return types, see Renderer outputs.

Install Core

Section titled “Install Core”

Use this default when you need SVG, terminal text, or raw matrix output.

Terminal window
npm install @qrcodesdk/core

Install browser output

Section titled “Install browser output”

Add Canvas elements, PNG-backed Image elements, and browser download helpers.

Terminal window
npm install @qrcodesdk/core @qrcodesdk/browser

Install Node.js PNG output

Section titled “Install Node.js PNG output”
Terminal window
npm install @qrcodesdk/core @qrcodesdk/node

Install React components

Section titled “Install React components”
Terminal window
npm install @qrcodesdk/core @qrcodesdk/browser @qrcodesdk/react

React and React DOM are peer dependencies; use the versions already selected by your application.

Install Vue components

Section titled “Install Vue components”
Terminal window
npm install @qrcodesdk/core @qrcodesdk/browser @qrcodesdk/vue

Vue is a peer dependency; use the Vue 3 version already selected by your application.

Install Svelte components

Section titled “Install Svelte components”
Terminal window
npm install @qrcodesdk/core @qrcodesdk/browser @qrcodesdk/svelte

Svelte is a peer dependency; use the Svelte 5 version already selected by your application.

Install Angular components

Section titled “Install Angular components”
Terminal window
npm install @qrcodesdk/core @qrcodesdk/browser @qrcodesdk/angular

Angular, RxJS, and their normal runtime dependencies are peers; use your application’s versions.

Install the CLI

Section titled “Install the CLI”
Terminal window
npm install -g @qrcodesdk/cli

Next steps

Section titled “Next steps”

Open the package page linked in the table for its minimal example and package-specific behavior. If you chose Core, continue with the SVG string renderer.