Skip to content

qkiroc/qrcode-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

二维码生成器

一款基于 react 的二维码生成器

demo 试用地址:https://qkiroc.github.io/qrcode-react/

安装

npm install qrcode-react-next

使用示例

import {QRCode} from 'qrcode-react-next';

function component() {
  return <QRCode value="test" />;
}

配置说明

参数 类型 默认值 是否必填 说明
value string - 二维码的内容
mode 'svg' | 'canvas' 'canvas' 二维码的渲染模式
config QRCodeConfig - 二维码的配置,包括纠错级别、版本等
styleConfig QRCodeStyleConfig - 二维码的样式配置,包括大小、颜色、边距等
logoConfig QrCodeLogoConfig - 二维码中间的 logo 配置,包括图片路径、宽高等
className string - 自定义样式类名

QRCodeConfig 配置说明

参数 类型 默认值 是否必填 说明
level 'L'|'M'|'Q'|'H' 'L' 纠错级别
minVersion number 1 最小版本
maxVersion number 40 最大版本
mask number - 掩码模式(-1~7)
boostLevel boolean false 是否提升纠错级别

QRCodeStyleConfig 配置说明

参数 类型 默认值 是否必填 说明
size number 200 二维码的大小
margin number 4 二维码的边距
color string '#000000' 二维码的颜色
bgColor string '#FFFFFF' 二维码的背景颜色
eyeType 'default'| 'rounded' | 'circle' 'default' 码眼的类型
eyeBorderSize 'default' | 'sm' | 'xs' 'default' 码眼边框的大小
eyeBorderColor string - 码眼边框的颜色
eyeInnerColor string - 码眼内部的颜色
pointType 'default' | 'circle' 'default' 码点的类型
pointSize 'default' | 'sm' | 'xs' 'default' 码点的大小
pointSizeRandom boolean false 码点的大小是否随机

QrCodeLogoConfig 配置说明

参数 类型 默认值 是否必填 说明
src string - logo 图片的路径
width number 二维码大小的 1/5 logo 图片的宽度
height number 二维码大小的 1/5 logo 图片的高度
x number 居中 logo 图片的 x 坐标
y number 居中 logo 图片的 y 坐标

About

二维码生成

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published