yx-qrcode
v1.0.0
Published
一个功能强大的二维码生成器,支持多种样式、渐变、码眼自定义等特性
Maintainers
Readme
@impression/qrcode-generator
一个功能强大的二维码生成器库,支持多种样式、渐变、码眼自定义等特性。
特性
- 🎨 支持多种码眼样式(20+种)
- 🌈 支持线性渐变和径向渐变
- 🎯 支持码眼外圈和中心独立颜色设置
- 📐 支持自定义模块大小、边距、缩放
- 🔧 TypeScript 支持
- 📦 零依赖(除核心编码库)
安装
npm install @impression/qrcode-generator快速开始
import { createQrcode } from '@impression/qrcode-generator';
// 基础用法
const svg = await createQrcode('Hello World', {
moduleSize: 10,
color: '#1976d2',
background: '#ffffff',
});
// 使用渐变
const svg = await createQrcode('Hello World', {
colorGradient: 'to right #ff6600 #ff0066',
background: '#ffffff',
});
// 自定义码眼样式
const svg = await createQrcode('Hello World', {
finderShape: 'circle',
eyeShape: 'star',
color: '#000000',
background: '#ffffff',
});API 文档
createQrcode(text, config)
生成二维码并返回 SVG 字符串。
参数
text(string): 要编码的文本内容config(Partial): 配置对象
配置选项
level('L' | 'M' | 'Q' | 'H'): 错误纠正级别,默认 'L'moduleSize(number): 每个模块的像素大小,默认 10margin(number): 边距(模块数),默认 0scale(number): 整体放大倍数,默认 1.0color(string): 前景颜色colorGradient(string): 前景渐变(格式:'to right #ff0000 #00ff00' 或 'radial #ff0000 #00ff00')background(string): 背景颜色backgroundGradient(string): 背景渐变finderShape(string): 码圈样式,默认 'default'eyeShape(string): 码眼中心样式,默认 'default'outerEyeColor(string): 码眼外圈颜色innerEyeColor(string): 码眼中心颜色
支持的样式
Finder 样式(码圈)
- default, flurry, sdoz, drop_in, drop, dropeye, circle, rounded, flower, leaf, vortex, dots, bruised, canvas 等
Eye 样式(码眼中心)
- default, circle, star, diamond, heart, sun, vortex, sparkle_dot, 9-dots, flower, elastic, diagonal, ropes 等
许可证
MIT
