Monthly Downloads: 0
Programming language: TypeScript
License: GNU General Public License v3.0 or later
Tags: Utilities     React     React-component     Qrcode    
Latest version: v3.1.0

qrcode.react alternatives and similar libraries

Based on the "Utilities" category.
Alternatively, view qrcode.react alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of qrcode.react or a related project?

Add another 'Utilities' Library



A React component to generate QR codes for rendering to the DOM.


npm install qrcode.react


qrcode.react exports three components, supporting rendering as SVG or Canvas. SVG is generally recommended as it is more flexible, but Canvas may be preferable.

All examples are shown using modern JavaScript modules and syntax. CommonJS require('qrcode.react') is also supported.


import ReactDOM from 'react-dom';
import {QRCodeSVG} from 'qrcode.react';

  <QRCodeSVG value="https://reactjs.org/" />,


import ReactDOM from 'react-dom';
import {QRCodeCanvas} from 'qrcode.react';

  <QRCodeCanvas value="https://reactjs.org/" />,


Note: Usage of this is deprecated as of v3. It is available as the default export for compatiblity with previous versions. The renderAs prop is only supported with this component.

import ReactDOM from 'react-dom';
import QRCode from 'qrcode.react';

  <QRCode value="https://reactjs.org/" renderAs="canvas" />,

Available Props

prop type default value note
value string
renderAs string ('canvas' 'svg') 'canvas'
size number 128
bgColor string "#FFFFFF" CSS color
fgColor string "#000000" CSS color
level string ('L' 'M' 'Q' 'H') 'L'
includeMargin boolean false DEPRECATED. This is being remvoed in favor of marginSize
marginSize number 0 Specifies the number of modules to use for margin around the symbol. The QR Code specification requires 4, however you may use other values. Values will be turned to integers with Math.floor. Overrides includeMargin default value when specified
imageSettings object See below


field type default value note
src string
x number none Will attempt to center if not specified
y number none Will attempt to center if not specified
height number 10% of size
width number 10% of size
excavate boolean false

Custom Styles

qrcode.react will pass through any additional props to the underlying DOM node (<svg> or <canvas>). This allows the use of inline style or custom className to customize the rendering. One common use would be to support a responsive layout.

Note: In order to render QR Codes in <canvas> on high density displays, we scale the canvas element to contain an appropriate number of pixels and then use inline styles to scale back down. We will merge any additional styles, with custom height and width overriding our own values. This allows scaling to percentages but if scaling beyond the size, you will encounter blurry images. I recommend detecting resizes with something like react-measure to detect and pass the appropriate size when rendering to <canvas>.

Encoding Mode

qrcode.react supports encoding text only, in a single segment. The encoding library being used does minimal detection to determine if the text being encoded can follow an optimized path for Numeric or Alphanumeric modes, allowing for more data to be encoded. Otherwise, it will encode following Byte mode. This mode includes supports multi-byte Unicode characters such as Kanji, however it does not support the optimized Kanji encoding mode.


qrcode.react is licensed under the [ISC license](LICENSE).

qrcode.react bundles QR Code Generator, which is available under the [MIT license](src/third-party/qrcodegen/LICENSE).

*Note that all licence references and agreements mentioned in the qrcode.react README section above are relevant to that project's source code only.