npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-qrcode-logo

v3.0.0

Published

React component to generate a QR Code customizable with logo and more properties

Downloads

299,698

Readme

react-qrcode-logo

Typescript React component to generate a customizable QR Code.

Installation

npm install --save react-qrcode-logo

Usage

// import
import { QRCode } from 'react-qrcode-logo';

// usage
<QRCode value="https://github.com/gcoro/react-qrcode-logo" />

Compatibility

If you are using a React version >= 18, use react-qrcode-logo version >= 3.0.0

Props

| 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 | | 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 | | style | React.CSSProperties | | CSS style properties that will be applied to the canvas component |

Events

| Event Name | Returns | Description | |--------------------------|-------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------| | logoOnLoad | event: Event | Event that fires when the QR Code logo image has been loaded |

Methods

Methods must be called on a valid QRCode ref - learn more.

| Method Name | Arguments | Description | |--------------------------|-------------------------------------| ----------------------------------------------------------------------------------------------------------------------------------| | download | fileType?: 'png' | 'jpg' | 'webp', fileName?: string | This function will download the QR Code as image. Format and file name can be specified |

Example

You can find a demo project here.

Contributing

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 :)

More credits

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).