Introduction

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.

Demo

https://yudielcurbelo.github.io/react-web-qr-reader

Known Issues

• Server side rendering won't work so only require the component 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.

Install

npm install --save react-web-qr-reader

Example

import React, { useState } from 'react';
import QrReader from 'react-web-qr-reader';

const Example = () => {
  const delay = 500;

  const previewStyle = {
    height: 240,
    width: 320,
  };

  const [result, setResult] = useState('No result');

  const handleScan = (result) => {
    if (result) {
      setResult(result);
    }
  };

  const handleError = (error) => {
    console.log(error);
  };

  return (
    <>
      <QrReader
        delay={delay}
        style={previewStyle}
        onError={handleError}
        onScan={handleScan}
      />
      <p>{result}</p>
    </>
  );
};

export default Example;

Props

Events

| Prop | Argument | Description | | ------- | -------- | --------------------------------------------------------------------------------------------------------------- | | onScan | result | Scan event handler. Called every scan with the decoded value or null 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, streamLabel: string |

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

Tested platforms

• Chrome Windows, macOs, iOS & Android
• Firefox Windows, macOs, iOS & Android
• Safari macOs & iOS

License

The MIT License (MIT)

Copyright (c) 2018 Thomas Billiet

Copyright (c) 2021 Yudiel Curbelo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.