vue-qrcode-reader

WebJar for vue-qrcode-reader

License

License

MIT
Categories

Categories

Github Development Tools Version Controls
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

github-com-gruhn-vue-qrcode-reader
Last Version

Last Version

0.0.0-development
Release Date

Release Date

Type

Type

jar
Description

Description

vue-qrcode-reader
WebJar for vue-qrcode-reader
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/gruhn/vue-qrcode-reader

Download github-com-gruhn-vue-qrcode-reader

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/github-com-gruhn-vue-qrcode-reader/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>github-com-gruhn-vue-qrcode-reader</artifactId>
    <version>0.0.0-development</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-gruhn-vue-qrcode-reader/
implementation 'org.webjars.npm:github-com-gruhn-vue-qrcode-reader:0.0.0-development'
// https://jarcasting.com/artifacts/org.webjars.npm/github-com-gruhn-vue-qrcode-reader/
implementation ("org.webjars.npm:github-com-gruhn-vue-qrcode-reader:0.0.0-development")
'org.webjars.npm:github-com-gruhn-vue-qrcode-reader:jar:0.0.0-development'
<dependency org="org.webjars.npm" name="github-com-gruhn-vue-qrcode-reader" rev="0.0.0-development">
  <artifact name="github-com-gruhn-vue-qrcode-reader" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='github-com-gruhn-vue-qrcode-reader', version='0.0.0-development')
)
libraryDependencies += "org.webjars.npm" % "github-com-gruhn-vue-qrcode-reader" % "0.0.0-development"
[org.webjars.npm/github-com-gruhn-vue-qrcode-reader "0.0.0-development"]

Dependencies

compile (4)

Group / Artifact Type Version
org.webjars.npm : babel-runtime jar [6.26.0,7)
org.webjars.npm : callforth jar [0.3.0,0.4)
org.webjars.npm : jsqr jar [1.2.0,2)
org.webjars.npm : webrtc-adapter jar [6.2.1,7)

Project Modules

There are no modules declared in this project.

Logo

for Vue.js 2 npm monthly downloads Travis CI: build status
is maintained? yes licence: MIT badges = awesome
uses semantic release code style: prettier
size minified + gzipped npm current version
Mentioned in Awesome Vue

live demos | api reference

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

  • ๐ŸŽฅ QrcodeStream accesses the device camera and continuously scans incoming frames.
  • ๐Ÿšฎ QrcodeDropZone renders to an empty region where you can drag-and-drop images to be decoded.
  • ๐Ÿ“‚ 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:

<qrcode-stream @decode="onDecode"></qrcode-stream>
methods: {
  onDecode (decodedString) {
    // ...
  }
}

Screenshots

Screenshot 1 Screenshot 2 Screenshot 3

Installation ๐Ÿ“ฆ

With NPM

Run

npm install vue-qrcode-reader

You can import the components independantly

import { QrcodeStream, QrcodeDropZone, QrcodeCapture } from 'vue-qrcode-reader'

const MyComponent = {

  components: {
    QrcodeStream,
    QrcodeDropZone,
    QrcodeCapture
  },

  // ...
))

or register all of them globally right away

import Vue from "vue";
import VueQrcodeReader from "vue-qrcode-reader";

Vue.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:

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

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

<qrcode-stream></qrcode-stream>
<qrcode-drop-zone></qrcode-drop-zone>
<qrcode-capture></qrcode-capture>

Troubleshooting โšก

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 ๐Ÿ™

BrowserStack Logo โ€ƒโ€ƒ Travis-CI Logo

Versions

Version
0.0.0-development