qrcode.react
Advanced tools
Package description
The qrcode.react npm package is a React component that uses the 'qrcode-generator' library to render QR codes as SVGs in React applications. It allows for easy creation and customization of QR codes directly within React components.
Generating a basic QR code
This feature allows you to generate a simple QR code by passing a string as the 'value' prop to the QRCode component.
{"import QRCode from 'qrcode.react';\n\nconst MyComponent = () => (\n <QRCode value='http://facebook.github.io/react/' />\n);"}Customizing the QR code
This feature enables customization of the QR code by setting props such as 'size' for dimension, 'bgColor' for background color, 'fgColor' for foreground color, and 'level' for error correction level.
{"import QRCode from 'qrcode.react';\n\nconst MyComponent = () => (\n <QRCode\n value='http://facebook.github.io/react/'\n size={256}\n bgColor={'#ffffff'}\n fgColor={'#000000'}\n level={'H'}\n />\n);"}Including a logo or image in the center of the QR code
This feature allows for the inclusion of a logo or image in the center of the QR code. The 'imageSettings' prop can be used to provide the image source and other related settings.
{"import QRCode from 'qrcode.react';\n\nconst MyComponent = () => (\n <QRCode\n value='http://facebook.github.io/react/'\n size={256}\n bgColor={'#ffffff'}\n fgColor={'#000000'}\n level={'H'}\n includeMargin={true}\n imageSettings={{\n src: 'path/to/logo.png',\n x: null,\n y: null,\n height: 24,\n width: 24,\n excavate: true,\n }}\n />\n);"}The 'qrcode' package is a more general QR code generator that can be used in both browser and server environments. It provides a wider range of options for generating QR codes, including output formats like PNG, UTF8, and others. Unlike qrcode.react, it is not specifically tailored for React and does not render as a React component.
The 'react-qr-code' package is another React component for generating QR codes. It is similar to qrcode.react in that it is designed for React and renders QR codes as SVGs. However, it may have different customization options and dependencies.
The 'react-native-qrcode-svg' package is designed for React Native applications and allows for the generation of QR codes as SVG elements. It is similar to qrcode.react but is specifically built for the React Native environment rather than for web applications.
Changelog
[2.0.0] - 2022-03-05
unsafe_* lifecycle methods, eliminating a warning from non-production environments.Readme
A React component to generate QR codes.
npm install qrcode.react
var React = require('react');
var QRCode = require('qrcode.react');
React.render(
<QRCode value="http://facebook.github.io/react/" />,
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) |
imageSettings| 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>.
FAQs
React component to generate QR codes
We found that qrcode.react demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.