2.0.0 • Published 13 days ago

@wojtekmaj/react-qr-svg v2.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
13 days ago

npm downloads CI

React-QR-SVG

Render QR codes as SVG in your React app.

tl;dr

  • Install by executing npm install @wojtekmaj/react-qr-svg or yarn add @wojtekmaj/react-qr-svg.
  • Import by adding import QrSvg from '@wojtekmaj/react-qr-svg'.
  • Use by adding <QrSvg value="Hello world" />.

Demo

A minimal demo page can be found in sample directory.

Getting started

Compatibility

Your project needs to use React 16.8 or later.

Need library for React Native? Check out React-Native-QR-SVG.

Installation

Add React-QR-SVG to your project by executing npm install @wojtekmaj/react-qr-svg or yarn add @wojtekmaj/react-qr-svg.

Usage

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.

User guide

QrSvg

Renders QR code as SVG.

Props

Prop nameDescriptionDefault valueExample values
bgColorBackground color."white"Color name: "beige"Color hex: "#fefefe"
cellClassPrefixCell class name prefix."""qr-svg__cell"
fgColorForeground color."black"Color name: "black"Color hex: "#000000"
levelError correction level. Can be "L", "M", "Q" and "H"."L""M"
marginMargin in pixels.04
typeType (size). Can be any number from 0 to 40. Set to 0 or leave as undefined to use the smallest possible size.010
valueValue 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).

License

The MIT License.

Author

Thank you

This project wouldn't be possible without the awesome work of Dan Homola dan.homola@hotmail.cz who created its original version.

2.0.0

13 days ago

1.0.0

5 months ago

0.5.0

10 months ago

0.5.1

7 months ago

0.4.2

1 year ago

0.4.1

1 year ago

0.4.0

1 year ago

0.3.0

2 years ago

0.2.0

2 years ago

0.1.0

2 years ago