1.0.0 • Published 4 years ago

react-qr-reader-demo v1.0.0

Weekly downloads
-
License
MLT
Repository
github
Last release
4 years ago

React QR Scanner Component

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

Table of contents

Browser Support

This component fundamentally depends on the Stream API.

ChromeFirefoxSafariEdgeIE
83.0 ✔77.0 ✔13.1.1 ✔83.0 ✔Not supported

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:

import React, { Component } from 'react'
import QrReader from 'react-qr-scanner'

class Test extends Component {
  constructor(props){
    super(props)
    this.state = {
      delay: 100,
      result: 'No result',
    }

    this.handleScan = this.handleScan.bind(this)
  }
  handleScan(data){
    this.setState({
      result: data,
    })
  }
  handleError(err){
    console.error(err)
  }
  render(){
    const previewStyle = {
      height: 240,
      width: 320,
    }

    return(
      <div>
        <QrReader
          delay={this.state.delay}
          style={previewStyle}
          onError={this.handleError}
          onScan={this.handleScan}
          />
        <p>{this.state.result}</p>
      </div>
    )
  }
}

Available Props

PropTypedefaultDescription
delaynumber500The delay between scans in milliseconds. To disable the interval pass in false.
facingModestringSpecify which camera direction should be used (if available). Options: front and rear.
legacyModebooleanfalseIf the device does not allow camera access (e.g. IOS Browsers, Safari) you can enable legacyMode to allow the user to take a picture (On a mobile device) or use an existing one. To trigger the image dialog just call the method openImageDialog from the parent component. Warning You must call the method from a user action (eg. click event on some element).
maxImageSizenumber1500If legacyMode is active then the image will be downscaled to the given value while keepings its aspect ratio. Allowing larger images will increase the accuracy but it will also slow down the processing time.
styleobjectStyling for the preview element. This will be a video or an img when legacymode is true. Warning The preview will keep its aspect ratio, to disable this set the CSS property objectFit to fill.
classNamestringClassName for the container element.
chooseDeviceIdfunctionCalled when choosing which device to use for scanning. By default chooses the first video device matching facingMode, if no devices match the first video device found is choosen.

Methods

NameDescription
onScanScan event handler. Called every scan with the decoded value or null if no QR code was found.
onErrorFunction to call when an error occurs such as:- Not supported platform -The lack of available devices
onLoadCalled when the component is ready for use.
onImageLoadCalled when the image in legacyMode is loaded.

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

react-weblineindia-qr-scanner,react,reactjs,react-component,qrcode,qrcode-reader,qrcode-scanner,webrtc