tahv0 / react-qr-reader2

React component for reading QR codes from webcam.

Introduction

This is fork from react-qr-reader. Some changes are being made. E.g. onLoad gives streamTrack object, not just streamLabel string. legacyMode is also been removed. I'll add it back later if it is needed for some reason.

A React component for reading QR codes from the webcam. It uses the WebRTC standards for reading webcam data and jsQR is used for detecting QR codes in that data. To optimise the speed and experience, a web-worker is used to offload the heavy QR code algorithm on a separate process. The web worker is inlined and loaded on creation of the component.

Known Issues

• Server side rendering won't work so only require the componont when rendering in a browser environment.
• Due to browser implementations the camera can only be accessed over https or localhost.
• In Firefox a prompt will be shown to the user asking which camera to use, so facingMode will not affect it.
• On IOS 11 it is only supported on Safari and not on Chrome or Firefox due to Apple making the API not available to 3rd party browsers.
• Camera won't open in iOS PWA Apps. https://stackoverflow.com/questions/46228218/how-to-access-camera-on-ios11-home-screen-web-app

Install

npm install --save react-qr-reader2

Example

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

class Test extends Component {
  state = {
    result: 'No result'
  }

  handleScan = data => {
    if (data) {
      this.setState({
        result: data
      })
    }
  }
  handleError = err => {
    console.error(err)
  }
  render() {
    return (
      <div>
        <QrReader
          delay={300}
          onError={this.handleError}
          onScan={this.handleScan}
          style={{ width: '100%' }}
        />
        <p>{this.state.result}</p>
      </div>
    )
  }
}

Props

Events

Prop	Argument	Description
onScan	result and chunks	Scan event handler. Called every scan with the decoded value in first parameter and with chunks array in second parameter. result is null and chunks is empty array if no QR code was found.
onError	Error	Called when an error occurs.
onLoad	object	Called when the component is ready for use. Object properties are mirrorVideo: boolean, streamTrack: object

Options

Prop	Type	Default	Description
delay	number or false	500	The delay between scans in milliseconds. To disable the interval pass in false.
facingMode	user or environment	environment	Specify which camera should be used (if available).
resolution	number	600	The resolution of the video. Larger resolution will increase the accuracy but it will also slow down the processing time.
style	a valid React style	none	Styling for the container element. Warning The preview will always keep its 1:1 aspect ratio.
className	string	none	ClassName for the container element.
showViewFinder	boolean	true	Show or hide the build in view finder. See demo
constraints	object	null	Use custom camera constraints that the override default behavior. MediaTrackConstraints

Dev

Install dependencies

npm install

Build

npm run build

Demo

npm run storybook

Linting

npm run lint

Tested platforms

• Chrome Android
• Firefox Android
• Safari iOS