qrcode.react 3.0.1
Install from the command line:
Learn more about npm packages
$ npm install @alpacahq/qrcode.react@3.0.1
Install via package.json:
"@alpacahq/qrcode.react": "3.0.1"
About this version
This is a copy of qrcode.react 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';
ReactDOM.render(
<QRCodeSVG value="https://reactjs.org/" />,
document.getElementById('mountNode')
);
import ReactDOM from 'react-dom';
import {QRCodeCanvas} from 'qrcode.react';
ReactDOM.render(
<QRCodeCanvas value="https://reactjs.org/" />,
document.getElementById('mountNode')
);
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';
ReactDOM.render(
<QRCode value="https://reactjs.org/" renderAs="canvas" />,
document.getElementById('mountNode')
);
prop | type | default value |
---|---|---|
value |
string |
|
renderAs |
string ('canvas' 'svg' ) |
'canvas' |
size |
number |
128 |
bgColor |
string (CSS color) |
"#FFFFFF" |
fgColor |
string (CSS color) |
"#000000" |
level |
string ('L' 'M' 'Q' 'H' ) |
'L' |
includeMargin |
boolean |
false |
imageSettings |
object (see below) |
field | type | default value |
---|---|---|
src |
string |
|
x |
number |
none, will center |
y |
number |
none, will center |
height |
number |
10% of size
|
width |
number |
10% of size
|
excavate |
boolean |
false |
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>
.
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.
qrcode.react
bundles QR Code Generator, which is available under the MIT license.
Details
- qrcode.react
- alpacahq
- over 2 years ago
- ISC
- 26 dependencies
Assets
- qrcode.react-3.0.1-npm.tgz
Download activity
- Total downloads 2,233
- Last 30 days 15
- Last week 13
- Today 0