Coder Social home page Coder Social logo

headless-react-qr-scanner's Introduction

headless-react-qr-scanner

A headless React QR code scanner component. Uses qr-scanner under the hood.

Installation

npm i headless-react-qr-scanner

Usage

import {QrScanner, Video, StartButton, StopButton} from "headless-react-qr-scanner";

function Demo() {
  return (
    <QrScanner onDecode={(res) => console.log(res.data)}>
      <Video style={{height: 600, width: 600}} />
      <StartButton>Start</StartButton>
      <StopButton>Stop</StopButton>
    </QrScanner>
  );
}

You can omit the buttons and pass autoStart prop to QrScanner to start the scanner automatically.

import {QrScanner, Video} from "headless-react-qr-scanner";

function Demo() {
  return (
    <QrScanner onDecode={(res) => console.log(res.data)} autoStart>
      <Video style={{height: 600, width: 600}} />
    </QrScanner>
  );
}

Styling

The components Video, StartButton and StopButton are unstyled by default. You can style them by passing a className o style prop to the components.

TODO

  • Add tests
  • Document props and components in README

headless-react-qr-scanner's People

Contributors

franciscohanna92 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.