Code Monkey home page Code Monkey logo

qrcode-react's Introduction

@nixjs23n6/qrcode-react

A React component to generate QRCode.

Install

yarn add @nixjs23n6/qrcode-react

Interface

export interface QRCodePropArg {
    value: string
    ecLevel?: 'L' | 'M' | 'Q' | 'H'
    enableCORS?: boolean
    size?: number
    margin?: number
    bgColor?: string
    fgColor?: string
    qrStyle?: 'squares' | 'dots'
    imageSettings?: ImageSettings
    className?: string
}

export interface ImageSettings {
    image?: string
    opacity?: number
    height?: number
    width?: number
}

value

The value of the QR code. [Required]

ecLevel

QR codes support four levels of error correction to enable recovery of missing, misread, or obscured data. Greater redundancy is achieved at the cost of being able to store less data. Know more, wikipedia: QR_code.

Possible levels are shown below:

Level Error resistance
L (Low) ~7%
M (Medium) ~15%
Q (Quartile) ~25%
H (High) ~30%

Default: M

enableCORS

Allowing cross-origin use of images and canvas.Default: false

size

Image size.Default: 125

margin

The width of the white border around the data portion of the code.Default: 15

bgColor

The background color of QRcode.Default: #FFFFFF

fgColor

The foreground color of QRcode.Default: #000000

qrStyle

Style QRcode: 'squares' | 'dots'.Default: squares

imageSettings

Allow user to add logo on QRcode.Default: { opacity: 1, height: 30, width: 30, image: '' }

export interface ImageSettings {
    image?: string
    opacity?: number
    height?: number
    width?: number
}

ImageSettings.image

Logo Image Path or Base64 encoded image.

ImageSettings.opacity

Set opacity for logo.

ImageSettings.height

fixed logo height.

ImageSettings.width

Fixed logo width.

className

Additional CSS class names to add to the container.

Example

import { QRCode } from "@nixjs23n6/qrcode-react"
export const Render = () => <QRCode value="0x2fEC6379E9a0B88D7c4C0BdC20adcFC7A23C3B68"
                imageSettings={{image: 'https:\\cdn.demo.com/busd.svg'}}
                bgColor="#e7e7e7"
                className="qrcode-my-address"
            />

qrcode-react's People

Watchers

 avatar  avatar

Forkers

cryptobuks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.