README.md

Vue QR Scanner Component

A Vue.js based QR Code scanner component, allowing you to detect and decode QR codes without leaving the browser.

Table of contents

• Browser Support
• Getting started
• Usage
• Want to Contribute?
• Need Help / Support?
• Collection of Components
• Changelog
• Credits
• License
• Keywords

Browser Support

QrcodeStream

This component fundamentally depends on the Stream API.

83.0 ✔	77.0 ✔	13.1.1 ✔	83.0 ✔	Not verified

1. Chrome requires HTTPS or localhost (see Troubleshooting for help)
2. Safari also requires HTTPS even on localhost. It also won't work in:
   • Chrome for iOS, Firefox for iOS,
   • WkWebView component of native iOS apps
   • web apps added to home screen (PWA mode) prior to iOS 13.4

QrcodeDropZone and QrcodeCapture

The newest API these components depend on is the FileReader API.

83.0 ✔	77.0 ✔	13.1.1 ✔	83.0 ✔	10+

Getting started

Install the npm package:

npm install vue-weblineindia-qrcode-scanner
#OR
yarn add vue-weblineindia-qrcode-scanner

Usage

Use the <vue-weblineindia-qrcode-scanner> component:

Either import the components independantly for local registration:

import { QrcodeStream, QrcodeDropZone, QrcodeCapture } from 'vue-weblineindia-qr-scanner'

const MyComponent = {

  components: {
    QrcodeStream,
    QrcodeDropZone,
    QrcodeCapture
  },

  // ...
))

Or register all of them globally:

import Vue from "vue";
import VueQrcodeReader from "vue-weblineindia-qr-scanner";

Vue.use(VueQrcodeReader);

Import Css

• <link href="vue-weblineindia-qr-scanner.css" rel="stylesheet">
• <script src="vue-weblineindia-qr-scanner.browser.js"></script>

Want to Contribute?

• Created something awesome, made this code better, added some functionality, or whatever (this is the hardest part).
• Fork it.
• Create new branch to contribute your changes.
• Commit all your changes to your branch.
• Submit a pull request.

---

Need Help?

We also provide a free, basic support for all users who want to use this VueJS QR code scanner in their software project. In case you want to customize this VueJS QR code scanner to suit your development needs, then feel free to contact our VueJS developers.

---

Collection of Components

We have built many other components and free resources for software development in various programming languages. Kindly click here to view our Free Resources for Software Development

---

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

Credits

vue-weblineindia-qr-scanner is inspired by vue-qrcode-reader.

License

MIT

Keywords

vue-weblineindia-qr-scanner, vue, vuejs, vue-component, qrcode, qrcode-reader, qrcode-scanner, webrtc