Installations

npm install vue-qrcode-reader-vue3

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.18.1

NPM Version

6.14.15 Score

60.2

Supply Chain

97.8

Quality

74.6

Maintenance

100

Vulnerability

98.9

License

Pull Requests

Open

1

Total

143

Closed

48

Merged

94

Issues

Open

4

Total

319

Closed

315

Releases

109

v3.2.1

Published on 15 Jan 2025

v5.7.0

Published on 27 Dec 2024

v5.6.0

Published on 17 Dec 2024

v5.5.11

Published on 09 Oct 2024

v5.5.10

Published on 23 Sept 2024

v5.5.9

Published on 20 Sept 2024

View all 109 releases

Contributors

29

View all 29 contributors

Languages

5

TypeScript

Vue

Nix

JavaScript

Shell

TypeScript (55.6%)

Vue (42.3%)

Nix (1.35%)

JavaScript (0.74%)

Shell (0.02%)

Developer

gruhn

Download Statistics

Total Downloads

317

Last Day

1

Last Week

1

Last Month

3

Last Year

46

GitHub Statistics

2,156 Stars

375 Commits

343 Forks

33 Watching

22 Branches

29 Contributors

Bundle Size

360.08 kB

Minified

126.55 kB

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

0.0.0-development

Package Id

vue-qrcode-reader-vue3@0.0.0-development

Unpacked Size

3.83 MB

Size

1.68 MB

File Count

78

NPM Version

6.14.15

Node Version

14.18.1

Total Downloads

Cumulative downloads

Total Downloads

317

Last day

0%

1

Compared to previous day

Last week

0%

1

Compared to previous week

Last month

-25%

3

Compared to previous month

Last year

-50%

46

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

6

barcode-detector callforth core-js vue @vue/compat webrtc-adapter

Dev Dependencies

14

@vue/cli-plugin-babel @vue/cli-plugin-eslint @vue/cli-service @vue/compiler-sfc @vue/eslint-config-prettier babel-eslint eslint eslint-plugin-prettier eslint-plugin-vue husky lint-staged prettier semantic-release vuepress

Versions

live demos | api reference

A set of Vue.js components, allowing you to detect and decode QR codes, without leaving the browser.

:movie_camera: QrcodeStream accesses the device camera and continuously scans incoming frames.
:put_litter_in_its_place: QrcodeDropZone renders to an empty region where you can drag-and-drop images to be decoded.
:open_file_folder: QrcodeCapture is a classic file upload field, instantly scanning all files you select.

All components are responsive. Beyond that, close to zero styling. Make them fit your layout. Usage is simple and straight forward:

1<qrcode-stream @decode="onDecode"></qrcode-stream>

1methods: {
2  onDecode (decodedString) {
3    // ...
4  }
5}

Screenshots

Screenshot 1 Screenshot 2 Screenshot 3

Installation :package:

With NPM

Run

1npm install vue-qrcode-reader

You can import the components independantly

1import { QrcodeStream, QrcodeDropZone, QrcodeCapture } from 'vue-qrcode-reader'
2
3const MyComponent = {
4
5  components: {
6    QrcodeStream,
7    QrcodeDropZone,
8    QrcodeCapture
9  },
10
11  // ...
12))

or register all of them globally right away

1import Vue from "vue";
2import VueQrcodeReader from "vue-qrcode-reader";
3
4Vue.use(VueQrcodeReader);

Without NPM

Include the following JS file:

https://unpkg.com/vue-qrcode-reader/dist/VueQrcodeReader.umd.min.js

Make sure to include it after Vue:

1<script src="./vue.js"></script>
2<script src="./VueQrcodeReader.umd.min.js"></script>

All components are automatically registered globally. Use kebab-case to reference them in your templates:

1<qrcode-stream></qrcode-stream>
2<qrcode-drop-zone></qrcode-drop-zone>
3<qrcode-capture></qrcode-capture>

Troubleshooting :zap:

I don't see the camera when using `QrcodeStream`.

Check if it works on the demo page. Especially the Decode All demo, since it renders error messages. If you see errors, consult the docs to understand their meaning.
- The demo works but it doesn't work in my project: Listen for the init event to investigate errors.
- The demo doesn't work: Carefully review the Browser Support section above. Maybe your device is just not supported.

I'm running a dev server on localhost. How to test on my mobile device without HTTPS?

If your setup is Desktop Chrome + Android Chrome, use Remote Debugging which allows your Android device to access your local server as localhost.
Otherwise use a reverse proxy like ngrok or serveo to temporarily make your local server publicly available with HTTPS.
There are also loads of serverless/static hosting services that have HTTPS enabled by default and where you can deploy your web app for free (e.g. GitHub Pages, GitLab Pages, Google Firebase, Netlify, Heroku, ZEIT Now, ...)

Some of my QR codes are not being detected.

Make sure, there is some white border around the QR code.
Color inverted QR codes are not supported (dark background, light foreground).
Model 1 QR codes are also not supported.

Thanks :pray:

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

5

Maintained

Determines if the project is "actively maintained".

3

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

vue-qrcode-reader-vue3

Installations

Developer Guide

No

CommonJS

14.18.1

6.14.15

Score

Pull Requests

1

143

48

94

Issues

4

319

315

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

360.08 kB

126.55 kB

Maintainers

Package Meta Information

Total Downloads

317

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

Screenshots

Installation :package:

With NPM

Without NPM

Troubleshooting :zap:

I don't see the camera when using QrcodeStream.

I'm running a dev server on localhost. How to test on my mobile device without HTTPS?

Some of my QR codes are not being detected.

Thanks :pray:

10

10

10

10

5

3

0

0

0

0

0

0

0

4

/10

Other packages similar to vue-qrcode-reader-vue3

I don't see the camera when using `QrcodeStream`.