Render QR codes as SVG in your React app.
- Install by executing
npm install @wojtekmaj/react-qr-svg
oryarn add @wojtekmaj/react-qr-svg
. - Import by adding
import QrSvg from '@wojtekmaj/react-qr-svg'
. - Use by adding
<QrSvg value="Hello world" />
.
A minimal demo page can be found in sample
directory.
Your project needs to use React 16.8 or later.
Need library for React Native? Check out React-Native-QR-SVG.
Add React-QR-SVG to your project by executing npm install @wojtekmaj/react-qr-svg
or yarn add @wojtekmaj/react-qr-svg
.
Here's an example of basic usage:
import QrSvg from '@wojtekmaj/react-qr-svg';
function MyApp() {
return (
<div>
<QrSvg value="Hello world" />
</div>
);
}
Check the sample directory in this repository for a full working example.
Renders QR code as SVG.
Prop name | Description | Default value | Example values |
---|---|---|---|
bgColor | Background color. | "white" |
|
cellClassPrefix | Cell class name prefix. | "" |
"qr-svg__cell" |
fgColor | Foreground color. | "black" |
|
level | Error correction level. Can be "L" , "M" , "Q" and "H" . |
"L" |
"M" |
margin | Margin in pixels. | 0 |
4 |
type | Type (size). Can be any number from 0 to 40. Set to 0 or leave as undefined to use the smallest possible size. |
0 |
10 |
value | Value to render. | n/a | "Hello world" |
You can also specify all the props that are valid for the <svg>
React element (e.g. style
, className
or width
).
The MIT License.
Wojciech Maj |
This project wouldn't be possible without the awesome work of Dan Homola dan.homola@hotmail.cz who created its original version.