Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
react-qrcode-logo
Advanced tools
Changelog
[v2.10.0]
qrStyle
: fluid
.Readme
Typescript React component to generate a customizable QR Code.
npm install --save react-qrcode-logo
import * as React from 'react';
import { QRCode } from 'react-qrcode-logo';
React.render(
<QRCode value="https://github.com/gcoro/react-qrcode-logo" />,
mountNode
);
Prop | Type | Default value | Description |
---|---|---|---|
value | string | https://reactjs.org/ | The value encoded in the QR Code. When the QR Code is decoded, this value will be returned |
ecLevel | L | M | Q | H | M | The error correction level of the QR Code |
enableCORS | boolean | false | Enable crossorigin attribute |
size | number (in pixels) | 150 | The size of the QR Code |
quietZone | number (in pixels) | 10 | The size of the quiet zone around the QR Code. This will have the same color as QR Code bgColor |
bgColor | string (css color) | #FFFFFF | Background color |
fgColor | string (css color) | #000000 | Foreground color |
logoImage | string (src attribute) | The logo image. It can be a url/path or a base64 value | |
logoWidth | number (in pixels) | size * 0.2 | Logo image width |
logoHeight | number (in pixels) | logoWidth | Logo image height |
logoOpacity | number (css opacity 0 <= x <= 1) | 1 | Logo opacity. This allows you to modify the transparency of your logo, so that it won't compromise the readability of the QR Code |
logoOnLoad | () => void | Callback function to know when the logo in the QR Code is loaded | |
removeQrCodeBehindLogo | boolean | false | Removes points behind the logo. If no logoPadding is specified, the removed part will have the same size as the logo |
logoPadding | number | Adds a border with no points around the logo. When > 0, the padding will be visible even if the prop removeQrCodeBehindLogo is not set to true | |
logoPaddingStyle | square | circle | square | Sets the shape of the padding area around the logo |
qrStyle | squares | dots | fluid | squares | Style of the QR Code modules |
eyeRadius | CornerRadii | CornerRadii[] | The corner radius for the positional patterns (the three "eyes" around the QR code). See more details here | |
eyeColor | EyeColor | EyeColor[] | The color for the positional patterns (the three "eyes" around the QR code). See more details here | |
id | string | react-qrcode-logo | Optional custom id for the QRCode canvas. You can use this prop if you have multiple QRCodes and need to differentiate them |
You can find a very simple demo project here.
PRs and suggestions are welcome. When making a pull request, please explain in a clear way the changes you made and why you are making them (+ if you can also update the README accordingly, ty <3). Also try keep the current repo codestyle (eg. do not reformat all the code with prettier).
Thanks to everyone who contributed and/or will contribute :)
gcoro |
jgillick |
dos1in |
halitogunc |
joellord |
Michael-AT-Corporation |
qwei-1874 |
Trexy94 |
ty-everett |
larstel |
This package was inspired by cssivision/qrcode-react and zpao/qrcode.react. Also looked up some parts from kazuhikoarase/qrcode-generator (which this package depends on).
FAQs
React component to generate a QR Code customizable with logo and more properties
The npm package react-qrcode-logo receives a total of 47,127 weekly downloads. As such, react-qrcode-logo popularity was classified as popular.
We found that react-qrcode-logo demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.