@lglab/react-qr-code 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.es.js +512 -442
- package/package.json +22 -3
package/README.md
CHANGED
|
@@ -1,6 +1,52 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
1
3
|
# @lglab/react-qr-code
|
|
2
4
|
|
|
3
5
|
A highly customizable and lightweight QR code generator for React applications.
|
|
4
6
|
|
|
5
7
|
🚀 **Live Demo:** [reactqrcode.com/demo](https://reactqrcode.com/demo)
|
|
6
8
|
📖 **Documentation:** [reactqrcode.com](https://reactqrcode.com/)
|
|
9
|
+
|
|
10
|
+
## Quick Features
|
|
11
|
+
|
|
12
|
+
- **Highly Customizable** - Style the finder patterns, modules, and colors exactly how you want.
|
|
13
|
+
- **Performance Optimized** - Generates QR codes efficiently without sacrificing quality.
|
|
14
|
+
- **SVG-Based Rendering** - Crisp and scalable output for web and print
|
|
15
|
+
- **Developer-Friendly** - Style the finder patterns, modules, and colors exactly how you want.
|
|
16
|
+
- **Highly Customizable** - Built with TypeScript, easy to use, and well-documented
|
|
17
|
+
|
|
18
|
+
## Install
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
pnpm add @lglab/react-qr-code
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
or
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
npm i @lglab/react-qr-code
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
or
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
yarn add @lglab/react-qr-code
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
or
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
bun add @lglab/react-qr-code
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Quick Start
|
|
43
|
+
|
|
44
|
+
```
|
|
45
|
+
import { ReactQRCode } from '@lglab/react-qr-code'
|
|
46
|
+
|
|
47
|
+
const Page = () => {
|
|
48
|
+
return (
|
|
49
|
+
<ReactQRCode value='https://reactqrcode.com' />
|
|
50
|
+
);
|
|
51
|
+
}
|
|
52
|
+
```
|
package/dist/index.d.ts
CHANGED
|
@@ -13,7 +13,7 @@ export declare interface DataModulesSettings {
|
|
|
13
13
|
randomSize?: boolean;
|
|
14
14
|
}
|
|
15
15
|
|
|
16
|
-
export declare type DataModulesStyle = 'square' | 'square-sm' | 'rounded' | 'leaf' | 'vertical-line' | 'horizontal-line' | 'circle' | 'diamond' | 'star' | 'heart';
|
|
16
|
+
export declare type DataModulesStyle = 'square' | 'square-sm' | 'rounded' | 'leaf' | 'vertical-line' | 'horizontal-line' | 'circle' | 'diamond' | 'star' | 'heart' | 'hashtag';
|
|
17
17
|
|
|
18
18
|
export declare type DownloadFileFormat = 'svg' | 'png' | 'jpeg';
|
|
19
19
|
|
|
@@ -41,7 +41,7 @@ export declare interface FinderPatternInnerSettings {
|
|
|
41
41
|
style?: FinderPatternInnerStyle;
|
|
42
42
|
}
|
|
43
43
|
|
|
44
|
-
export declare type FinderPatternInnerStyle = 'square' | 'rounded-sm' | 'rounded' | 'rounded-lg' | 'circle' | 'inpoint-sm' | 'inpoint' | 'inpoint-lg' | 'outpoint-sm' | 'outpoint' | 'outpoint-lg' | 'leaf-sm' | 'leaf' | 'leaf-lg' | 'diamond' | 'star' | 'heart';
|
|
44
|
+
export declare type FinderPatternInnerStyle = 'square' | 'rounded-sm' | 'rounded' | 'rounded-lg' | 'circle' | 'inpoint-sm' | 'inpoint' | 'inpoint-lg' | 'outpoint-sm' | 'outpoint' | 'outpoint-lg' | 'leaf-sm' | 'leaf' | 'leaf-lg' | 'diamond' | 'star' | 'heart' | 'hashtag';
|
|
45
45
|
|
|
46
46
|
export declare interface FinderPatternOuterSettings {
|
|
47
47
|
color?: string;
|