Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
vue-qrcode-reader
Advanced tools
A Vue.js component, accessing the device camera and allowing users to read QR-Codes, within the browser
A Vue.js 2 component, accessing the device camera and allowing users to read QR codes, within the browser.
No | Yes | Yes | Yes | 11+ |
decode
eventOnce a stream from the users camera is loaded, it is displayed and continuously scanned for QR codes. Results are indicated by the decode
event. This also accounts for decoded images drag-and-dropped in the area the component occupies.
<qrcode-reader @decode="onDecode"></qrcode-reader>
methods: {
onDecode (decodedString) {
// ...
}
}
You might notice that when you scan the same QR code multiple times in a row,
decode
is still only emitted once. When you hold a QR code in the camera, frames are actually decoded multiple times a second but you don't want to be flooded withdecode
events that often. That's why the last decoded QR code is always cached and only new results are propagated. However, you can clear this internal cache by setting thepaused
prop to true.
detect
eventThe detect
event is quite similar to decode
but it provides more details. decode
only gives you the string encoded by QR codes. detect
additionally
In case of errors decode
also silently fails. For example when a non-image file is drag-and-dropped.
<qrcode-reader @detect="onDetect"></qrcode-reader>
methods: {
async onDetect (promise) {
try {
const {
source, // 'file', 'url' or 'stream'
imageData, // raw image data of image/frame
content, // decoded String
location // QR code coordinates
} = await promise
// ...
} catch (error) {
if (error.name === 'DropImageFetchError') {
// drag-and-dropped URL (probably just an <img> element) from different
// domain without CORS header caused same-origin-policy violation
} else if (error.name === 'DropImageDecodeError') {
// drag-and-dropped file is not of type image and can't be decoded
} else {
// idk, open an issue ¯\_(ツ)_/¯
}
}
}
}
init
eventIt might take a while before the component is ready and the scanning process starts. The user has to be asked for camera access permission first and the camera stream has to be loaded.
If you want to show a loading indicator, you can listen for the init
event. It's emitted as soon as the component is mounted and carries a promise which resolves when everything is ready. The promise is rejected if initialization fails. This can have a couple of reasons.
In Chrome you can't prompt users for permissions a second time. Once denied, users can only manually grant them. Make sure your users understand why you need access to their camera before you mount this component. Otherwise they might panic and deny and then get frustrated because they don't know how to change their decision.
<qrcode-reader @init="onInit"></qrcode-reader>
methods: {
async onInit (promise) {
// show loading indicator
try {
await promise
// successfully initialized
} catch (error) {
if (error.name === 'NotAllowedError') {
// user denied camera access permisson
} else if (error.name === 'NotFoundError') {
// no suitable camera device installed
} else if (error.name === 'NotSupportedError') {
// page is not served over HTTPS (or localhost)
} else if (error.name === 'NotReadableError') {
// maybe camera is already in use
} else if (error.name === 'OverconstrainedError') {
// passed constraints don't match any camera.
// Did you requested the front camera although there is none?
} else {
// browser might be lacking features (WebRTC, ...)
}
} finally {
// hide loading indicator
}
}
}
track
propBy default detected QR codes are visually highlighted. A transparent canvas overlays the camera stream. When a QR code is detected, its location is painted to the canvas. You can enable/disable this feature by passing true
/false
via the track
prop. If tracking is disabled the camera stream is scanned much less frequently. So if you encounter performance problems on your target device, this might help.
You can also pass a function with track
to customize the way the location is painted. This function is called to produce each frame. It receives the location object as the first argument and a CanvasRenderingContext2D
instance as the second argument.
Avoid access to reactive properties in this function (like stuff in
data
,computed
or your Vuex store). The function is called several times a second and might cause memory leaks. If you want to be save don't accessthis
at all.
Say you want to paint in a different color that better fits your overall page theme.
<qrcode-reader :track="repaintLocation"></qrcode-reader>
methods: {
repaintLocation (location, ctx) {
if (location !== null) {
const {
topLeftCorner,
topRightCorner,
bottomLeftCorner,
bottomRightCorner,
} = location
ctx.strokeStyle = 'blue' // instead of red
ctx.beginPath()
ctx.moveTo(topLeftCorner.x, topLeftCorner.y)
ctx.lineTo(bottomLeftCorner.x, bottomLeftCorner.y)
ctx.lineTo(bottomRightCorner.x, bottomRightCorner.y)
ctx.lineTo(topRightCorner.x, topRightCorner.y)
ctx.lineTo(topLeftCorner.x, topLeftCorner.y)
ctx.closePath()
ctx.stroke()
}
}
}
Distributed content will overlay the camera stream, wrapped in a position: absolute
container.
<qrcode-reader>
<b>stuff here overlays the camera stream</b>
</qrcode-reader>
paused
propWith the paused
prop you can prevent further decode
propagation and functions passed via track
are stopped being called. Useful for example if you want to validate results one at a time. This will also freeze the camera stream.
<qrcode-reader @decode="onDecode" :paused="paused"></qrcode-reader>
data () {
return {
paused: false
}
},
methods: {
onDecode (content) {
this.paused = true
// ...
}
}
video-constraints
propThis component uses getUserMedia to request camera streams. This method accepts a constraints object to configure for example if front or rear camera should be accessed. This is passed by default:
{
audio: false, // don't request microphone access
video: {
facingMode: { ideal: 'environment' }, // use rear camera if available
width: { min: 360, ideal: 680, max: 1920 }, // constrain video width resolution
height: { min: 240, ideal: 480, max: 1080 }, // constrain video height resolution
}
}
You can change the video
part using the video-constraints
prop. Note that you only have to pass properties you want to override. If you want to use the front camera for example and change nothing else, pass this:
<qrcode-reader :video-constraints="{ facingMode: 'user' }"></qrcode-reader>
If you change this property after initialization, a new camera stream will be requested and the
init
event will be emitted again.
yarn add vue-qrcode-reader
or using NPM:
npm install --save vue-qrcode-reader
Register component globally:
import Vue from 'vue'
import VueQrcodeReader from 'vue-qrcode-reader'
Vue.use(VueQrcodeReader)
Register locally in other components scope:
import Vue from 'vue'
import { QrcodeReader } from 'vue-qrcode-reader'
Vue.component('my-component', {
components: { QrcodeReader },
// ...
)
⚠️ A css file is included when importing the package. You may have to setup your bundler to embed the css in your page.
Register component globally:
import 'vue-qrcode-reader/dist/vue-qrcode-reader.css'
import VueQrcodeReader from 'vue-qrcode-reader/dist/vue-qrcode-reader.common'
Vue.use(VueQrcodeReader)
Register locally in other components scope:
import 'vue-qrcode-reader/dist/vue-qrcode-reader.css'
import { QrcodeReader } from 'vue-qrcode-reader/dist/vue-qrcode-reader.common'
Vue.component('my-component', {
components: { QrcodeReader },
// ...
)
⚠️ You may have to setup your bundler to embed the css file in your page.
<link rel="stylesheet" href="vue-qrcode-reader/dist/vue-qrcode-reader.css"/>
<script src="vue.js"></script>
<script src="vue-qrcode-reader/dist/vue-qrcode-reader.browser.js"></script>
The plugin should be auto-installed. If not, you can install it manually with the instructions below.
Register component globally:
Vue.use(VueQrcodeReader)
Register locally in other components scope:
Vue.component('my-component', {
components: {
'qrcode-reader': VueQrcodeReader.QrcodeReader
},
// ...
)
Register component globally:
import Vue from 'vue'
import VueQrcodeReader from 'vue-qrcode-reader/src'
Vue.use(VueQrcodeReader)
Register locally in other components scope:
import Vue from 'vue'
import { QrcodeReader } from 'vue-qrcode-reader/src'
Vue.component('my-component', {
components: { QrcodeReader },
// ...
)
⚠️ You need to configure your bundler to compile .vue
files. More info in the official documentation.
FAQs
A set of Vue.js components for detecting and decoding QR codes.
The npm package vue-qrcode-reader receives a total of 15,523 weekly downloads. As such, vue-qrcode-reader popularity was classified as popular.
We found that vue-qrcode-reader demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.