React-hook-qrcode NPM

react-hook-qrcode

React hooks for generating QR code.

npm bundle size

🎁 Features

Render as Canvas & Image
Support Numeric, Alphanumeric, Kanji and Byte mode
Support Japanese, Chinese, Greek and Cyrillic characters
Support multibyte characters (like emojis smile)

🔧 Install

react-hook-qrcode is available on npm. It can be installed with the following command:

npm install --save react-hook-qrcode

react-hook-qrcode is available on yarn as well. It can be installed with the following command:

yarn add react-hook-qrcode

💡 Canvas

usage

import React from 'react';
import { useQRCode } from 'react-hook-qrcode';

function App() {
  const [inputRef] = useQRCode({
    text: 'https://github.com/bunlong/react-hook-qrcode',
    options: {
      level: 'M',
      margin: 7,
      scale: 1,
      width: 200,
      color: {
        dark: '#010599FF',
        light: '#FFBF60FF',
      },
    },
  });
  
  return <canvas ref={inputRef} />;
};

export default App;

parameters

options

💡 Image

usage

import React from 'react';
import { useQRCode } from 'react-hook-qrcode';

function App() {
  const [inputRef] = useQRCode({
    text: 'https://github.com/bunlong/react-hook-qrcode',
    options: {
      type: 'image/jpeg',
      quality: 0.3,
      level: 'M',
      margin: 3,
      scale: 4,
      width: 200,
      color: {
        dark: '#010599FF',
        light: '#FFBF60FF',
      },
    },
  });
  
  return <img ref={inputRef} />;
};

export default App;

parameters

options

💖 Wrap Up

If you think any of the react-hook-qrcode can be improved, please do open a PR with any updates and submit any issues. Also, I will continue to improve this, so you might want to watch/star this repository to revisit.