React QR Scan

Repository: https://github.com/ssttechdev/react-qr-scan

Table of contents

• Use Case
• Compatibility
• Installation
  • NPM
  • YARN
• Example Usage
• QrReader API
• Browser support
• Issues
• Contributing
• License

Use Case

You need a component for Scanning QR codes from a web browser based app.

Compatibility

This component has been tested in the following browsers:

• Chrome Mac OS & Android
• Firefox Mac OS & Android
• Safari Mac OS & IOS

Since this library does internal use of hooks you need React >= 18.0.0 (React 19 supported).

Installation

You can install this library via NPM or YARN.

NPM

npm i react-qr-scan

YARN

yarn add react-qr-scan

Example Usage

After reading and performing the previous steps, you should be able to import the library and use it like in this example:

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

const Test = (props) => {
  const [data, setData] = useState('No result');

  return (
    <>
      <QrReader
        onResult={(
          result,
          error,
          codeReader,
          location,
          locationError,
          deviceInfo
        ) => {
          if (!!result) {
            setData(result?.text);
          }

          if (!!error) {
            console.info(error);
          }

          if (!!location) {
            console.info(
              'Location:',
              location.coords.latitude,
              location.coords.longitude
            );
          }

          if (!!locationError) {
            console.info('Location error:', locationError);
          }

          if (!!deviceInfo) {
            console.info('Device info:', deviceInfo);
          }
        }}
        enableLocation
        enableDeviceInfo
        style={{ width: '100%' }}
      />
      <p>{data}</p>
    </>
  );
};

Notes

• Geolocation requires user permission and only works on HTTPS or localhost.
• enableDeviceInfo is heuristic and can be spoofed by the browser.

Component API

The QrReader component has the following props:

| Properties | Types | Default Value | Description | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------ | -------------------------------------------------------- | | constraints | MediaTrackConstraints | { facingMode: 'user' } | Specify which camera should be used (if available). | | onResult | function | none | Scan event handler | | videoId | string | video | The ID for the video element | | scanDelay | number | 500 | The scan period for the QR hook | | enableLocation | boolean | false | Attach geolocation data to scan results | | locationOptions | PositionOptions | none | Options for the geolocation API | | enableDeviceInfo | boolean | false | Attach device info (heuristic) to scan results | | ViewFinder | component | none | ViewFinder component to rendering over the video element | | className | string | none | ClassName for the container element. | | containerStyle | object | none | Style object for the container element. | | videoContainerStyle | object | none | Style object for the video container element. | | videoStyle | object | none | Style object for the video element. |

Maintainers

• Created by @JodusNodus .
• Revived thanks to @JonatanSalas and his company @BlackBoxVision .
• Updated by @wsnugrho

Browser Support

If you need to support older browsers, checkout this guide in how to make it compatible with legacy ones

Issues

Please, open an issue following one of the issues templates. We will do our best to fix them.

Contributing

If you want to contribute to this project see contributing for more information.

License

Distributed under the MIT license. See LICENSE for more information.