@qrcodesdk/vue
Vue components that render QR codes as inline SVG, as PNG, WebP, GIF, or JPEG Image elements, or as Canvas elements.
Install
Section titled “Install”npm install @qrcodesdk/vuepnpm add @qrcodesdk/vuevp add @qrcodesdk/vuedeno add npm:@qrcodesdk/vuebun add @qrcodesdk/vueyarn add @qrcodesdk/vueQuick start
Section titled “Quick start”Import a component in a Vue single-file component:
<script setup lang="ts">import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/vue';
const options: QRCodeSVGOptions = { accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'},};</script>
<template> <figure> <QRCodeSVG payload="https://qrcodesdk.dev" :options="options" /> <figcaption> Scan the code or open <a href="https://qrcodesdk.dev">qrcodesdk.dev</a> </figcaption> </figure></template>ariaLabelnames the QR code for screen readers. The link gives everyone another way to reach the destination.- Without
accessibilityoptions, the QR code is decorative and hidden from assistive technology. Leave it unlabeled only when nearby content, such as this link, already explains it. QRCodePNG,QRCodeWebP,QRCodeGIF,QRCodeJPEG, andQRCodeCanvastake the samepayloadandoptionsprops. Image components also acceptaccessibility.alt.
Version compatibility
Section titled “Version compatibility”| @qrcodesdk/vue | Vue |
|---|---|
0.x.x |
^3.3.0 |
Components
Section titled “Components”Each output format has its own component. Your bundle only includes the encoders of the components you import.
| Component | Output | Download support |
|---|---|---|
QRCodeSVG | Inline SVG element | SVG |
QRCodePNG | PNG-backed <img> | PNG |
QRCodeWebP | WebP-backed <img> | WebP |
QRCodeGIF | GIF-backed <img> | GIF |
QRCodeJPEG | JPEG-backed <img> | JPEG |
QRCodeCanvas | <canvas> element | None |
Component props
| Prop | Type | Description |
|---|---|---|
payload | string | number | Required QR code payload. |
options | Component-specific options | Optional matrix options and renderer options, such as QRCodeSVGOptions for QRCodeSVG. |
class, style, other attributes and listeners | Fallthrough attributes | Applied to the wrapper <div> that contains the output element. innerHTML, innerText, and textContent are dropped. |
Template ref | QRCodeDownloadHandle | Exposes download(filename?) on every component except QRCodeCanvas, which exposes nothing. |
Choose an image format
Section titled “Choose an image format”QRCodePNGuses the browser’s native PNG encoder.QRCodeWebPuses a lossless encoder bundled in the SDK. It also works in Safari and usually produces the smallest file.QRCodeGIFis limited to 256 colors and on-or-off transparency. Prefer PNG or WebP for transparent backgrounds and photographic center images.QRCodeJPEGis lossy and has no transparency. It blends transparent pixels onto a white matte by default. Itsqualityoption ranges from 1 to 100 and defaults to 92. Use it only when a destination requires JPEG.
See Image element renderers for details.
Live examples
Section titled “Live examples”SVG component
Section titled “SVG component”<script setup lang="ts">import {QRCodeSVG, type QRCodeSVGOptions} from '@qrcodesdk/vue';
const options: QRCodeSVGOptions = { accessibility: { title: 'QR code for qrcodesdk.dev', ariaLabel: 'Scan to open qrcodesdk.dev', },};</script>
<template> <QRCodeSVG payload="https://qrcodesdk.dev" :options="options" /></template>PNG component
Section titled “PNG component”<script setup lang="ts">import {QRCodePNG, type QRCodePNGImageOptions} from '@qrcodesdk/vue';
const options: QRCodePNGImageOptions = { style: {moduleSize: 8, quietZone: 4}, accessibility: { alt: 'QR code: scan to open qrcodesdk.dev', },};</script>
<template> <QRCodePNG payload="https://qrcodesdk.dev" :options="options" /></template>WebP component
Section titled “WebP component”<script setup lang="ts">import {QRCodeWebP, type QRCodeWebPImageOptions} from '@qrcodesdk/vue';
const options: QRCodeWebPImageOptions = { style: {moduleSize: 8, quietZone: 4}, accessibility: { alt: 'QR code: scan to open qrcodesdk.dev', },};</script>
<template> <QRCodeWebP payload="https://qrcodesdk.dev" :options="options" /></template>GIF component
Section titled “GIF component”<script setup lang="ts">import {QRCodeGIF, type QRCodeGIFImageOptions} from '@qrcodesdk/vue';
const options: QRCodeGIFImageOptions = { style: {moduleSize: 8, quietZone: 4}, accessibility: { alt: 'QR code: scan to open qrcodesdk.dev', },};</script>
<template> <QRCodeGIF payload="https://qrcodesdk.dev" :options="options" /></template>JPEG component
Section titled “JPEG component”<script setup lang="ts">import {QRCodeJPEG, type QRCodeJPEGImageOptions} from '@qrcodesdk/vue';
const options: QRCodeJPEGImageOptions = { style: {moduleSize: 8, quietZone: 4}, quality: 90, accessibility: { alt: 'QR code: scan to open qrcodesdk.dev', },};</script>
<template> <QRCodeJPEG payload="https://qrcodesdk.dev" :options="options" /></template>Canvas component
Section titled “Canvas component”<script setup lang="ts">import {QRCodeCanvas, type QRCodeCanvasOptions} from '@qrcodesdk/vue';
const options: QRCodeCanvasOptions = { style: { moduleSize: 8, quietZone: 4, foreground: '#111827', background: '#ffffff', }, accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'},};</script>
<template> <QRCodeCanvas payload="https://qrcodesdk.dev" :options="options" /></template>PNG download
Section titled “PNG download”<script setup lang="ts">import {QRCodePNG, type QRCodeDownloadHandle, type QRCodePNGImageOptions} from '@qrcodesdk/vue';import {ref} from 'vue';
const qrcode = ref<QRCodeDownloadHandle | null>(null);const options: QRCodePNGImageOptions = { accessibility: {alt: 'QR code: scan to open qrcodesdk.dev'},};</script>
<template> <QRCodePNG ref="qrcode" payload="https://qrcodesdk.dev" :options="options" /> <button type="button" @click="qrcode?.download('qrcodesdk')">Download PNG</button></template>Center images
Section titled “Center images”For PNG, WebP, GIF, JPEG, and Canvas components:
- Load and decode a browser image.
- Store it in a
shallowRef. - Pass
canvasCenterImage(image)asoptions.centerImage. - Render the component only after the image is ready.
QRCodeSVG takes svgCenterImage() with an embedded data URL instead. See
Add a center image for the complete Vue example.
Download files
Section titled “Download files”Every component except QRCodeCanvas exposes download(filename?). Get it through a template
ref. The method appends the file extension when needed.
See Download or save for a complete Vue example. For manual downloads, see Export a canvas manually.
Server-side rendering
Section titled “Server-side rendering”QRCodeSVGproduces runtime-neutral SVG and renders on the server.QRCodePNG,QRCodeWebP,QRCodeGIF,QRCodeJPEG, andQRCodeCanvasneed browser DOM and Canvas APIs. On the server, they render an empty wrapper and skip downloads. They fill the wrapper after mounting in the browser.
Shared options
Section titled “Shared options”The options prop groups encoding settings under matrix. Renderer settings, such as style,
accessibility, and centerImage, sit next to it:
import {type QRCodeSVGOptions, circle, finder, rounded} from '@qrcodesdk/vue';
const options: QRCodeSVGOptions = { matrix: {errorCorrectionLevel: 'H'}, style: {moduleSize: 8, quietZone: 4, modules: rounded(), finder: finder({center: circle()})}, accessibility: {ariaLabel: 'Scan to open qrcodesdk.dev'},};Each component has its own options type:
| Component | Options type | Extra options |
|---|---|---|
QRCodeSVG |
QRCodeSVGOptions |
None |
QRCodePNG |
QRCodePNGImageOptions |
None |
QRCodeWebP |
QRCodeWebPImageOptions |
None |
QRCodeGIF |
QRCodeGIFImageOptions |
transparency.threshold |
QRCodeJPEG |
QRCodeJPEGImageOptions |
quality, transparency.matte |
QRCodeCanvas |
QRCodeCanvasOptions |
None |
Learn more about each group:
- Builder and matrix covers the fields inside
matrix. - Customize appearance covers
style. - Renderer outputs covers output-specific options.
Import payload helpers, such as wifiPayload(), from @qrcodesdk/vue.
QRCodeError comes from @qrcodesdk/core. To use it,
add Core to the project.
Mixed-mode segmentation
Section titled “Mixed-mode segmentation”Mixed-mode segmentation is opt-in. Import automaticSegmenter from @qrcodesdk/vue and pass it as
matrix.segmenter:
import {type QRCodeSVGOptions, automaticSegmenter} from '@qrcodesdk/vue';
const options: QRCodeSVGOptions = {matrix: {mode: 'auto', segmenter: automaticSegmenter}};Keep options stable
Section titled “Keep options stable”Vue tracks options reactively.
- Replacing the object renders the QR code again.
- Changing a property of a reactive object also renders it again.
- Changing a property of a plain, non-reactive object has no effect.
- An object literal in the template, such as
:options="{style: {moduleSize: 8}}", is a new object on every parent render. The QR code renders again each time.
Define options in <script setup>, or derive them with computed().
Errors
Section titled “Errors”Components throw QRCodeError for invalid payloads and options.
| Component | Where it throws |
|---|---|
QRCodeSVG |
During rendering, from computed values |
| Image and Canvas components | In a watcher after mounting |
To handle them:
- Catch both cases with
onErrorCaptured()in a parent component or withapp.config.errorHandler. - For server-side rendering, validate user-controlled payloads before rendering.
- Wrap downloads called from an event handler in your own
try/catch.
See Check errors from framework packages.
Public API
Section titled “Public API”import { type QRCodeAlignmentCenterShape, type QRCodeAlignmentOptions, type QRCodeAlignmentRingShape, type QRCodeAlignmentStyle, type QRCodeBaseProps, QRCodeCanvas, type QRCodeCanvasAccessibilityOptions, type QRCodeCanvasCenterImage, type QRCodeCanvasOptions, type QRCodeCanvasProps, type QRCodeCenterImageLayout, type QRCodeCircleShapeOptions, type QRCodeColor, type QRCodeDataImageURL, type QRCodeDownloadHandle, type QRCodeEncodingMode, type QRCodeErrorCorrectionLevel, type QRCodeFinderCenterShape, type QRCodeFinderOptions, type QRCodeFinderRingShape, type QRCodeFinderStyle, QRCodeGIF, type QRCodeGIFImageOptions, type QRCodeGIFProps, type QRCodeImageAccessibilityOptions, QRCodeJPEG, type QRCodeJPEGImageOptions, type QRCodeJPEGProps, type QRCodeKanji, type QRCodeMask, type QRCodeMatrixOptions, type QRCodeMode, type QRCodeModulePattern, type QRCodeModuleShape, QRCodePNG, type QRCodePNGImageOptions, type QRCodePNGProps, type QRCodePayload, type QRCodeRoundedShapeOptions, QRCodeSVG, type QRCodeSVGAccessibilityOptions, type QRCodeSVGCenterImage, type QRCodeSVGOptions, type QRCodeSVGProps, type QRCodeSegment, type QRCodeSegmenter, type QRCodeSegmenterOptions, type QRCodeShape, type QRCodeShapePath, type QRCodeShapePiece, type QRCodeVersion, type QRCodeVisualStyle, QRCodeWebP, type QRCodeWebPImageOptions, type QRCodeWebPProps, alignment, automaticSegmenter, canvasCenterImage, circle, customShape, diagonal, finder, kanji, rounded, svgCenterImage,} from '@qrcodesdk/vue';@qrcodesdk/vue
- Version
- v0.0.6
- Downloads
- 735/mo
- Install size
- 802.9 kB
- Bundled size
- 35.6 kB
Related pages
Section titled “Related pages”Support QRCodeSDK
If you find QRCodeSDK useful, please consider sponsoring the project!