@wirunrom/hqr-generate 0.2.1 → 0.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 +96 -14
- package/bundler/react.d.ts +20 -3
- package/bundler/react.js +45 -7
- package/index.bundler.js +6 -0
- package/index.d.ts +14 -0
- package/index.web.js +6 -0
- package/package.json +1 -1
- package/pkg/bundler/README.md +96 -14
- package/pkg/bundler/hqr_generate.d.ts +3 -1
- package/pkg/bundler/hqr_generate.js +1 -1
- package/pkg/bundler/hqr_generate_bg.js +40 -13
- package/pkg/bundler/hqr_generate_bg.wasm +0 -0
- package/pkg/bundler/hqr_generate_bg.wasm.d.ts +2 -1
- package/pkg/web/README.md +96 -14
- package/pkg/web/hqr_generate.d.ts +5 -2
- package/pkg/web/hqr_generate.js +40 -13
- package/pkg/web/hqr_generate_bg.wasm +0 -0
- package/pkg/web/hqr_generate_bg.wasm.d.ts +2 -1
- package/react/index.d.ts +14 -3
- package/react/index.js +53 -2
package/README.md
CHANGED
|
@@ -1,11 +1,25 @@
|
|
|
1
1
|
# @wirunrom/hqr-generate
|
|
2
2
|
|
|
3
|
-
A **stable black-and-white QR Code generator** that returns a **PNG Data URL**, powered by **Rust + WebAssembly (WASM)**.
|
|
3
|
+
A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- High-contrast **black & white only** output (maximum scan compatibility)
|
|
12
|
+
- Optimized for both **old and new mobile devices**
|
|
13
|
+
- Deterministic and consistent QR output
|
|
14
|
+
- Lightweight and fast (**Rust + WASM**)
|
|
15
|
+
- Supports both:
|
|
16
|
+
- **PNG Data URL** (simple usage)
|
|
17
|
+
- **PNG raw bytes** (best performance)
|
|
18
|
+
- Works out of the box with:
|
|
19
|
+
- Plain HTML
|
|
20
|
+
- React
|
|
21
|
+
- Next.js (Pages Router & App Router)
|
|
22
|
+
- Modern bundlers (Vite, Webpack, etc.)
|
|
9
23
|
|
|
10
24
|
---
|
|
11
25
|
|
|
@@ -15,18 +29,86 @@ A **stable black-and-white QR Code generator** that returns a **PNG Data URL**,
|
|
|
15
29
|
npm install @wirunrom/hqr-generate
|
|
16
30
|
```
|
|
17
31
|
|
|
18
|
-
## Usage (React / Next.js)
|
|
32
|
+
## Basic Usage (Browser / React / Next.js)
|
|
33
|
+
|
|
34
|
+
Generate PNG Data URL (simple & compatible)
|
|
19
35
|
|
|
20
36
|
```ts
|
|
21
37
|
import { qr_png_data_url } from "@wirunrom/hqr-generate";
|
|
22
38
|
|
|
23
|
-
const src = await qr_png_data_url(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
39
|
+
const src = await qr_png_data_url("hello", 320, 4, "Q");
|
|
40
|
+
<img src={src} alt="QR Code" />
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Generate PNG Bytes
|
|
44
|
+
Using raw bytes avoids Base64 overhead and is more memory-efficient.
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { qr_png_bytes } from "@wirunrom/hqr-generate";
|
|
48
|
+
|
|
49
|
+
const bytes = await qr_png_bytes("hello", 320, 4, "Q");
|
|
50
|
+
const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
|
|
51
|
+
|
|
52
|
+
<img src={url} alt="QR Code" />
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## React Hook Helper
|
|
56
|
+
|
|
57
|
+
**useQrPngDataUrl**
|
|
58
|
+
A React hook that generates a PNG Data URL and updates automatically when inputs change.
|
|
29
59
|
|
|
30
|
-
|
|
31
|
-
|
|
60
|
+
```ts
|
|
61
|
+
import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
|
|
62
|
+
|
|
63
|
+
function QR() {
|
|
64
|
+
const src = useQrPngDataUrl("hello world", {
|
|
65
|
+
size: 320,
|
|
66
|
+
margin: 4,
|
|
67
|
+
ecc: "Q",
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
if (!src) return null;
|
|
71
|
+
return <img src={src} alt="QR Code" />;
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**useQrPngBlobUrl**
|
|
76
|
+
A React hook that generates a Blob URL and updates automatically when inputs change.
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
|
|
80
|
+
|
|
81
|
+
function QR() {
|
|
82
|
+
const src = useQrPngBlobUrl("hello world", {
|
|
83
|
+
size: 320,
|
|
84
|
+
margin: 4,
|
|
85
|
+
ecc: "Q",
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
if (!src) return null;
|
|
89
|
+
return <img src={src} alt="QR Code" />;
|
|
90
|
+
}
|
|
32
91
|
```
|
|
92
|
+
|
|
93
|
+
## API Reference
|
|
94
|
+
|
|
95
|
+
**qr_png_data_url(text, size?, margin?, ecc?)**
|
|
96
|
+
Generate a QR code and return a PNG Data URL.
|
|
97
|
+
|
|
98
|
+
| Name | Type | Default | Description |
|
|
99
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
100
|
+
| text | `string` | — | Text to encode |
|
|
101
|
+
| size | `number` | `320` | Image size in pixels |
|
|
102
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
103
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
|
104
|
+
|
|
105
|
+
**qr_png_bytes(text, size?, margin?, ecc?)**
|
|
106
|
+
Generate a QR code and return PNG raw bytes (Uint8Array).
|
|
107
|
+
This is the fastest and most memory-efficient option.
|
|
108
|
+
|
|
109
|
+
| Name | Type | Default | Description |
|
|
110
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
111
|
+
| text | `string` | — | Text to encode |
|
|
112
|
+
| size | `number` | `320` | Image size in pixels |
|
|
113
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
114
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
package/bundler/react.d.ts
CHANGED
|
@@ -1,6 +1,23 @@
|
|
|
1
|
-
|
|
1
|
+
export type QrEcc = "L" | "M" | "Q" | "H";
|
|
2
2
|
|
|
3
|
-
export
|
|
3
|
+
export interface UseQrPngOptions {
|
|
4
|
+
size?: number;
|
|
5
|
+
margin?: number;
|
|
6
|
+
ecc?: QrEcc;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
/**
|
|
10
|
+
* React hook that returns PNG Data URL string (base64).
|
|
11
|
+
*/
|
|
12
|
+
export declare function useQrPngDataUrl(
|
|
13
|
+
text: string,
|
|
14
|
+
opts?: UseQrPngOptions
|
|
15
|
+
): string;
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* React hook that returns Blob URL string.
|
|
19
|
+
*/
|
|
20
|
+
export declare function useQrPngBlobUrl(
|
|
4
21
|
text: string,
|
|
5
|
-
opts?:
|
|
22
|
+
opts?: UseQrPngOptions
|
|
6
23
|
): string;
|
package/bundler/react.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { useEffect, useState } from "react";
|
|
2
|
-
import { qr_png_data_url } from "../index.bundler.js";
|
|
2
|
+
import { qr_png_data_url, qr_png_bytes } from "../index.bundler.js";
|
|
3
3
|
|
|
4
|
-
export function
|
|
4
|
+
export function useQrPngDataUrl(text, opts) {
|
|
5
5
|
const size = opts?.size ?? 320;
|
|
6
6
|
const margin = opts?.margin ?? 4;
|
|
7
7
|
const ecc = opts?.ecc ?? "Q";
|
|
@@ -19,15 +19,53 @@ export function useQrCode(text, opts) {
|
|
|
19
19
|
}
|
|
20
20
|
|
|
21
21
|
qr_png_data_url(text, size, margin, ecc)
|
|
22
|
-
.then((res) =>
|
|
23
|
-
|
|
22
|
+
.then((res) => alive && setSrc(res))
|
|
23
|
+
.catch(() => alive && setSrc(""));
|
|
24
|
+
|
|
25
|
+
return () => {
|
|
26
|
+
alive = false;
|
|
27
|
+
};
|
|
28
|
+
}, [text, size, margin, ecc]);
|
|
29
|
+
|
|
30
|
+
return src;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
/**
|
|
34
|
+
* Faster than base64 data url: uses Blob URL + revokes on cleanup
|
|
35
|
+
*/
|
|
36
|
+
export function useQrPngBlobUrl(text, opts) {
|
|
37
|
+
const size = opts?.size ?? 320;
|
|
38
|
+
const margin = opts?.margin ?? 4;
|
|
39
|
+
const ecc = opts?.ecc ?? "Q";
|
|
40
|
+
|
|
41
|
+
const [src, setSrc] = useState("");
|
|
42
|
+
|
|
43
|
+
useEffect(() => {
|
|
44
|
+
let alive = true;
|
|
45
|
+
let objectUrl = "";
|
|
46
|
+
|
|
47
|
+
if (!text) {
|
|
48
|
+
setSrc("");
|
|
49
|
+
return () => {
|
|
50
|
+
alive = false;
|
|
51
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
qr_png_bytes(text, size, margin, ecc)
|
|
56
|
+
.then((bytes) => {
|
|
57
|
+
if (!alive) return;
|
|
58
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
59
|
+
objectUrl = URL.createObjectURL(
|
|
60
|
+
new Blob([bytes], { type: "image/png" }),
|
|
61
|
+
);
|
|
62
|
+
setSrc(objectUrl);
|
|
24
63
|
})
|
|
25
|
-
.catch(() =>
|
|
26
|
-
if (alive) setSrc("");
|
|
27
|
-
});
|
|
64
|
+
.catch(() => alive && setSrc(""));
|
|
28
65
|
|
|
29
66
|
return () => {
|
|
30
67
|
alive = false;
|
|
68
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
31
69
|
};
|
|
32
70
|
}, [text, size, margin, ecc]);
|
|
33
71
|
|
package/index.bundler.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import init, {
|
|
2
2
|
qr_png_data_url as _qr_png_data_url,
|
|
3
|
+
qr_png_bytes as _qr_png_bytes,
|
|
3
4
|
} from "./pkg/bundler/hqr_generate.js";
|
|
4
5
|
|
|
5
6
|
let _initPromise;
|
|
@@ -13,3 +14,8 @@ export async function qr_png_data_url(text, size = 320, margin = 4, ecc = "Q") {
|
|
|
13
14
|
await ensureInit();
|
|
14
15
|
return _qr_png_data_url(text, size, margin, ecc);
|
|
15
16
|
}
|
|
17
|
+
|
|
18
|
+
export async function qr_png_bytes(text, size = 320, margin = 4, ecc = "Q") {
|
|
19
|
+
await ensureInit();
|
|
20
|
+
return _qr_png_bytes(text, size, margin, ecc);
|
|
21
|
+
}
|
package/index.d.ts
CHANGED
|
@@ -1,8 +1,22 @@
|
|
|
1
1
|
export type QrEcc = "L" | "M" | "Q" | "H";
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* Generate QR code PNG as Data URL (base64).
|
|
5
|
+
*/
|
|
3
6
|
export declare function qr_png_data_url(
|
|
4
7
|
text: string,
|
|
5
8
|
size?: number,
|
|
6
9
|
margin?: number,
|
|
7
10
|
ecc?: QrEcc
|
|
8
11
|
): Promise<string>;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* Generate QR code PNG as raw bytes (Uint8Array).
|
|
15
|
+
* Recommended for best performance (Blob URL, upload, caching).
|
|
16
|
+
*/
|
|
17
|
+
export declare function qr_png_bytes(
|
|
18
|
+
text: string,
|
|
19
|
+
size?: number,
|
|
20
|
+
margin?: number,
|
|
21
|
+
ecc?: QrEcc
|
|
22
|
+
): Promise<Uint8Array>;
|
package/index.web.js
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import init, {
|
|
2
2
|
qr_png_data_url as _qr_png_data_url,
|
|
3
|
+
qr_png_bytes as _qr_png_bytes,
|
|
3
4
|
} from "./pkg/web/hqr_generate.js";
|
|
4
5
|
|
|
5
6
|
let _initPromise;
|
|
@@ -21,3 +22,8 @@ export async function qr_png_data_url(text, size = 320, margin = 4, ecc = "Q") {
|
|
|
21
22
|
await ensureInit();
|
|
22
23
|
return _qr_png_data_url(text, size, margin, ecc);
|
|
23
24
|
}
|
|
25
|
+
|
|
26
|
+
export async function qr_png_bytes(text, size = 320, margin = 4, ecc = "Q") {
|
|
27
|
+
await ensureInit();
|
|
28
|
+
return _qr_png_bytes(text, size, margin, ecc);
|
|
29
|
+
}
|
package/package.json
CHANGED
package/pkg/bundler/README.md
CHANGED
|
@@ -1,11 +1,25 @@
|
|
|
1
1
|
# @wirunrom/hqr-generate
|
|
2
2
|
|
|
3
|
-
A **stable black-and-white QR Code generator** that returns a **PNG Data URL**, powered by **Rust + WebAssembly (WASM)**.
|
|
3
|
+
A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- High-contrast **black & white only** output (maximum scan compatibility)
|
|
12
|
+
- Optimized for both **old and new mobile devices**
|
|
13
|
+
- Deterministic and consistent QR output
|
|
14
|
+
- Lightweight and fast (**Rust + WASM**)
|
|
15
|
+
- Supports both:
|
|
16
|
+
- **PNG Data URL** (simple usage)
|
|
17
|
+
- **PNG raw bytes** (best performance)
|
|
18
|
+
- Works out of the box with:
|
|
19
|
+
- Plain HTML
|
|
20
|
+
- React
|
|
21
|
+
- Next.js (Pages Router & App Router)
|
|
22
|
+
- Modern bundlers (Vite, Webpack, etc.)
|
|
9
23
|
|
|
10
24
|
---
|
|
11
25
|
|
|
@@ -15,18 +29,86 @@ A **stable black-and-white QR Code generator** that returns a **PNG Data URL**,
|
|
|
15
29
|
npm install @wirunrom/hqr-generate
|
|
16
30
|
```
|
|
17
31
|
|
|
18
|
-
## Usage (React / Next.js)
|
|
32
|
+
## Basic Usage (Browser / React / Next.js)
|
|
33
|
+
|
|
34
|
+
Generate PNG Data URL (simple & compatible)
|
|
19
35
|
|
|
20
36
|
```ts
|
|
21
37
|
import { qr_png_data_url } from "@wirunrom/hqr-generate";
|
|
22
38
|
|
|
23
|
-
const src = await qr_png_data_url(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
39
|
+
const src = await qr_png_data_url("hello", 320, 4, "Q");
|
|
40
|
+
<img src={src} alt="QR Code" />
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Generate PNG Bytes
|
|
44
|
+
Using raw bytes avoids Base64 overhead and is more memory-efficient.
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { qr_png_bytes } from "@wirunrom/hqr-generate";
|
|
48
|
+
|
|
49
|
+
const bytes = await qr_png_bytes("hello", 320, 4, "Q");
|
|
50
|
+
const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
|
|
51
|
+
|
|
52
|
+
<img src={url} alt="QR Code" />
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## React Hook Helper
|
|
56
|
+
|
|
57
|
+
**useQrPngDataUrl**
|
|
58
|
+
A React hook that generates a PNG Data URL and updates automatically when inputs change.
|
|
29
59
|
|
|
30
|
-
|
|
31
|
-
|
|
60
|
+
```ts
|
|
61
|
+
import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
|
|
62
|
+
|
|
63
|
+
function QR() {
|
|
64
|
+
const src = useQrPngDataUrl("hello world", {
|
|
65
|
+
size: 320,
|
|
66
|
+
margin: 4,
|
|
67
|
+
ecc: "Q",
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
if (!src) return null;
|
|
71
|
+
return <img src={src} alt="QR Code" />;
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**useQrPngBlobUrl**
|
|
76
|
+
A React hook that generates a Blob URL and updates automatically when inputs change.
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
|
|
80
|
+
|
|
81
|
+
function QR() {
|
|
82
|
+
const src = useQrPngBlobUrl("hello world", {
|
|
83
|
+
size: 320,
|
|
84
|
+
margin: 4,
|
|
85
|
+
ecc: "Q",
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
if (!src) return null;
|
|
89
|
+
return <img src={src} alt="QR Code" />;
|
|
90
|
+
}
|
|
32
91
|
```
|
|
92
|
+
|
|
93
|
+
## API Reference
|
|
94
|
+
|
|
95
|
+
**qr_png_data_url(text, size?, margin?, ecc?)**
|
|
96
|
+
Generate a QR code and return a PNG Data URL.
|
|
97
|
+
|
|
98
|
+
| Name | Type | Default | Description |
|
|
99
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
100
|
+
| text | `string` | — | Text to encode |
|
|
101
|
+
| size | `number` | `320` | Image size in pixels |
|
|
102
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
103
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
|
104
|
+
|
|
105
|
+
**qr_png_bytes(text, size?, margin?, ecc?)**
|
|
106
|
+
Generate a QR code and return PNG raw bytes (Uint8Array).
|
|
107
|
+
This is the fastest and most memory-efficient option.
|
|
108
|
+
|
|
109
|
+
| Name | Type | Default | Description |
|
|
110
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
111
|
+
| text | `string` | — | Text to encode |
|
|
112
|
+
| size | `number` | `320` | Image size in pixels |
|
|
113
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
114
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
|
|
4
|
-
export function
|
|
4
|
+
export function qr_png_bytes(text: string, size: number, margin: number, ecc: number): Uint8Array;
|
|
5
|
+
|
|
6
|
+
export function qr_png_data_url(text: string, size: number, margin: number, ecc: number): string;
|
|
@@ -2,31 +2,53 @@
|
|
|
2
2
|
* @param {string} text
|
|
3
3
|
* @param {number} size
|
|
4
4
|
* @param {number} margin
|
|
5
|
-
* @param {
|
|
5
|
+
* @param {number} ecc
|
|
6
|
+
* @returns {Uint8Array}
|
|
7
|
+
*/
|
|
8
|
+
export function qr_png_bytes(text, size, margin, ecc) {
|
|
9
|
+
const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
|
|
10
|
+
const len0 = WASM_VECTOR_LEN;
|
|
11
|
+
const ret = wasm.qr_png_bytes(ptr0, len0, size, margin, ecc);
|
|
12
|
+
if (ret[2]) {
|
|
13
|
+
throw takeFromExternrefTable0(ret[1]);
|
|
14
|
+
}
|
|
15
|
+
return takeFromExternrefTable0(ret[0]);
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* @param {string} text
|
|
20
|
+
* @param {number} size
|
|
21
|
+
* @param {number} margin
|
|
22
|
+
* @param {number} ecc
|
|
6
23
|
* @returns {string}
|
|
7
24
|
*/
|
|
8
25
|
export function qr_png_data_url(text, size, margin, ecc) {
|
|
9
|
-
let
|
|
10
|
-
let
|
|
26
|
+
let deferred3_0;
|
|
27
|
+
let deferred3_1;
|
|
11
28
|
try {
|
|
12
29
|
const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
|
|
13
30
|
const len0 = WASM_VECTOR_LEN;
|
|
14
|
-
const
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
var ptr3 = ret[0];
|
|
18
|
-
var len3 = ret[1];
|
|
31
|
+
const ret = wasm.qr_png_data_url(ptr0, len0, size, margin, ecc);
|
|
32
|
+
var ptr2 = ret[0];
|
|
33
|
+
var len2 = ret[1];
|
|
19
34
|
if (ret[3]) {
|
|
20
|
-
|
|
35
|
+
ptr2 = 0; len2 = 0;
|
|
21
36
|
throw takeFromExternrefTable0(ret[2]);
|
|
22
37
|
}
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
return getStringFromWasm0(
|
|
38
|
+
deferred3_0 = ptr2;
|
|
39
|
+
deferred3_1 = len2;
|
|
40
|
+
return getStringFromWasm0(ptr2, len2);
|
|
26
41
|
} finally {
|
|
27
|
-
wasm.__wbindgen_free(
|
|
42
|
+
wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
|
|
28
43
|
}
|
|
29
44
|
}
|
|
45
|
+
export function __wbg___wbindgen_throw_be289d5034ed271b(arg0, arg1) {
|
|
46
|
+
throw new Error(getStringFromWasm0(arg0, arg1));
|
|
47
|
+
}
|
|
48
|
+
export function __wbg_new_from_slice_a3d2629dc1826784(arg0, arg1) {
|
|
49
|
+
const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
|
|
50
|
+
return ret;
|
|
51
|
+
}
|
|
30
52
|
export function __wbindgen_cast_0000000000000001(arg0, arg1) {
|
|
31
53
|
// Cast intrinsic for `Ref(String) -> Externref`.
|
|
32
54
|
const ret = getStringFromWasm0(arg0, arg1);
|
|
@@ -41,6 +63,11 @@ export function __wbindgen_init_externref_table() {
|
|
|
41
63
|
table.set(offset + 2, true);
|
|
42
64
|
table.set(offset + 3, false);
|
|
43
65
|
}
|
|
66
|
+
function getArrayU8FromWasm0(ptr, len) {
|
|
67
|
+
ptr = ptr >>> 0;
|
|
68
|
+
return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
|
|
69
|
+
}
|
|
70
|
+
|
|
44
71
|
function getStringFromWasm0(ptr, len) {
|
|
45
72
|
ptr = ptr >>> 0;
|
|
46
73
|
return decodeText(ptr, len);
|
|
Binary file
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
export const memory: WebAssembly.Memory;
|
|
4
|
-
export const
|
|
4
|
+
export const qr_png_bytes: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
|
|
5
|
+
export const qr_png_data_url: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
|
5
6
|
export const __wbindgen_externrefs: WebAssembly.Table;
|
|
6
7
|
export const __wbindgen_malloc: (a: number, b: number) => number;
|
|
7
8
|
export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
|
package/pkg/web/README.md
CHANGED
|
@@ -1,11 +1,25 @@
|
|
|
1
1
|
# @wirunrom/hqr-generate
|
|
2
2
|
|
|
3
|
-
A **stable black-and-white QR Code generator** that returns a **PNG Data URL**, powered by **Rust + WebAssembly (WASM)**.
|
|
3
|
+
A **stable black-and-white QR Code generator** that returns a **PNG Data URL or PNG bytes**, powered by **Rust + WebAssembly (WASM)**.
|
|
4
4
|
|
|
5
|
-
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
5
|
+
This library is designed with a **scan-reliability-first** mindset and a **frontend-first API**, making it easy to use in modern web applications without additional configuration.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Features
|
|
10
|
+
|
|
11
|
+
- High-contrast **black & white only** output (maximum scan compatibility)
|
|
12
|
+
- Optimized for both **old and new mobile devices**
|
|
13
|
+
- Deterministic and consistent QR output
|
|
14
|
+
- Lightweight and fast (**Rust + WASM**)
|
|
15
|
+
- Supports both:
|
|
16
|
+
- **PNG Data URL** (simple usage)
|
|
17
|
+
- **PNG raw bytes** (best performance)
|
|
18
|
+
- Works out of the box with:
|
|
19
|
+
- Plain HTML
|
|
20
|
+
- React
|
|
21
|
+
- Next.js (Pages Router & App Router)
|
|
22
|
+
- Modern bundlers (Vite, Webpack, etc.)
|
|
9
23
|
|
|
10
24
|
---
|
|
11
25
|
|
|
@@ -15,18 +29,86 @@ A **stable black-and-white QR Code generator** that returns a **PNG Data URL**,
|
|
|
15
29
|
npm install @wirunrom/hqr-generate
|
|
16
30
|
```
|
|
17
31
|
|
|
18
|
-
## Usage (React / Next.js)
|
|
32
|
+
## Basic Usage (Browser / React / Next.js)
|
|
33
|
+
|
|
34
|
+
Generate PNG Data URL (simple & compatible)
|
|
19
35
|
|
|
20
36
|
```ts
|
|
21
37
|
import { qr_png_data_url } from "@wirunrom/hqr-generate";
|
|
22
38
|
|
|
23
|
-
const src = await qr_png_data_url(
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
39
|
+
const src = await qr_png_data_url("hello", 320, 4, "Q");
|
|
40
|
+
<img src={src} alt="QR Code" />
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Generate PNG Bytes
|
|
44
|
+
Using raw bytes avoids Base64 overhead and is more memory-efficient.
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
import { qr_png_bytes } from "@wirunrom/hqr-generate";
|
|
48
|
+
|
|
49
|
+
const bytes = await qr_png_bytes("hello", 320, 4, "Q");
|
|
50
|
+
const url = URL.createObjectURL(new Blob([bytes], { type: "image/png" }));
|
|
51
|
+
|
|
52
|
+
<img src={url} alt="QR Code" />
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## React Hook Helper
|
|
56
|
+
|
|
57
|
+
**useQrPngDataUrl**
|
|
58
|
+
A React hook that generates a PNG Data URL and updates automatically when inputs change.
|
|
29
59
|
|
|
30
|
-
|
|
31
|
-
|
|
60
|
+
```ts
|
|
61
|
+
import { useQrPngDataUrl } from "@wirunrom/hqr-generate/react";
|
|
62
|
+
|
|
63
|
+
function QR() {
|
|
64
|
+
const src = useQrPngDataUrl("hello world", {
|
|
65
|
+
size: 320,
|
|
66
|
+
margin: 4,
|
|
67
|
+
ecc: "Q",
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
if (!src) return null;
|
|
71
|
+
return <img src={src} alt="QR Code" />;
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**useQrPngBlobUrl**
|
|
76
|
+
A React hook that generates a Blob URL and updates automatically when inputs change.
|
|
77
|
+
|
|
78
|
+
```ts
|
|
79
|
+
import { useQrPngBlobUrl } from "@wirunrom/hqr-generate/react";
|
|
80
|
+
|
|
81
|
+
function QR() {
|
|
82
|
+
const src = useQrPngBlobUrl("hello world", {
|
|
83
|
+
size: 320,
|
|
84
|
+
margin: 4,
|
|
85
|
+
ecc: "Q",
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
if (!src) return null;
|
|
89
|
+
return <img src={src} alt="QR Code" />;
|
|
90
|
+
}
|
|
32
91
|
```
|
|
92
|
+
|
|
93
|
+
## API Reference
|
|
94
|
+
|
|
95
|
+
**qr_png_data_url(text, size?, margin?, ecc?)**
|
|
96
|
+
Generate a QR code and return a PNG Data URL.
|
|
97
|
+
|
|
98
|
+
| Name | Type | Default | Description |
|
|
99
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
100
|
+
| text | `string` | — | Text to encode |
|
|
101
|
+
| size | `number` | `320` | Image size in pixels |
|
|
102
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
103
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
|
104
|
+
|
|
105
|
+
**qr_png_bytes(text, size?, margin?, ecc?)**
|
|
106
|
+
Generate a QR code and return PNG raw bytes (Uint8Array).
|
|
107
|
+
This is the fastest and most memory-efficient option.
|
|
108
|
+
|
|
109
|
+
| Name | Type | Default | Description |
|
|
110
|
+
| ------ | -------------------------- | ------- | ---------------------------- |
|
|
111
|
+
| text | `string` | — | Text to encode |
|
|
112
|
+
| size | `number` | `320` | Image size in pixels |
|
|
113
|
+
| margin | `number` | `4` | Quiet zone (recommended ≥ 4) |
|
|
114
|
+
| ecc | `"L" \| "M" \| "Q" \| "H"` | `"Q"` | Error correction level |
|
|
@@ -1,13 +1,16 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
|
|
4
|
-
export function
|
|
4
|
+
export function qr_png_bytes(text: string, size: number, margin: number, ecc: number): Uint8Array;
|
|
5
|
+
|
|
6
|
+
export function qr_png_data_url(text: string, size: number, margin: number, ecc: number): string;
|
|
5
7
|
|
|
6
8
|
export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
|
|
7
9
|
|
|
8
10
|
export interface InitOutput {
|
|
9
11
|
readonly memory: WebAssembly.Memory;
|
|
10
|
-
readonly
|
|
12
|
+
readonly qr_png_bytes: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
|
|
13
|
+
readonly qr_png_data_url: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
|
11
14
|
readonly __wbindgen_externrefs: WebAssembly.Table;
|
|
12
15
|
readonly __wbindgen_malloc: (a: number, b: number) => number;
|
|
13
16
|
readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
|
package/pkg/web/hqr_generate.js
CHANGED
|
@@ -4,35 +4,57 @@
|
|
|
4
4
|
* @param {string} text
|
|
5
5
|
* @param {number} size
|
|
6
6
|
* @param {number} margin
|
|
7
|
-
* @param {
|
|
7
|
+
* @param {number} ecc
|
|
8
|
+
* @returns {Uint8Array}
|
|
9
|
+
*/
|
|
10
|
+
export function qr_png_bytes(text, size, margin, ecc) {
|
|
11
|
+
const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
|
|
12
|
+
const len0 = WASM_VECTOR_LEN;
|
|
13
|
+
const ret = wasm.qr_png_bytes(ptr0, len0, size, margin, ecc);
|
|
14
|
+
if (ret[2]) {
|
|
15
|
+
throw takeFromExternrefTable0(ret[1]);
|
|
16
|
+
}
|
|
17
|
+
return takeFromExternrefTable0(ret[0]);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* @param {string} text
|
|
22
|
+
* @param {number} size
|
|
23
|
+
* @param {number} margin
|
|
24
|
+
* @param {number} ecc
|
|
8
25
|
* @returns {string}
|
|
9
26
|
*/
|
|
10
27
|
export function qr_png_data_url(text, size, margin, ecc) {
|
|
11
|
-
let
|
|
12
|
-
let
|
|
28
|
+
let deferred3_0;
|
|
29
|
+
let deferred3_1;
|
|
13
30
|
try {
|
|
14
31
|
const ptr0 = passStringToWasm0(text, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
|
|
15
32
|
const len0 = WASM_VECTOR_LEN;
|
|
16
|
-
const
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
var ptr3 = ret[0];
|
|
20
|
-
var len3 = ret[1];
|
|
33
|
+
const ret = wasm.qr_png_data_url(ptr0, len0, size, margin, ecc);
|
|
34
|
+
var ptr2 = ret[0];
|
|
35
|
+
var len2 = ret[1];
|
|
21
36
|
if (ret[3]) {
|
|
22
|
-
|
|
37
|
+
ptr2 = 0; len2 = 0;
|
|
23
38
|
throw takeFromExternrefTable0(ret[2]);
|
|
24
39
|
}
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
return getStringFromWasm0(
|
|
40
|
+
deferred3_0 = ptr2;
|
|
41
|
+
deferred3_1 = len2;
|
|
42
|
+
return getStringFromWasm0(ptr2, len2);
|
|
28
43
|
} finally {
|
|
29
|
-
wasm.__wbindgen_free(
|
|
44
|
+
wasm.__wbindgen_free(deferred3_0, deferred3_1, 1);
|
|
30
45
|
}
|
|
31
46
|
}
|
|
32
47
|
|
|
33
48
|
function __wbg_get_imports() {
|
|
34
49
|
const import0 = {
|
|
35
50
|
__proto__: null,
|
|
51
|
+
__wbg___wbindgen_throw_be289d5034ed271b: function(arg0, arg1) {
|
|
52
|
+
throw new Error(getStringFromWasm0(arg0, arg1));
|
|
53
|
+
},
|
|
54
|
+
__wbg_new_from_slice_a3d2629dc1826784: function(arg0, arg1) {
|
|
55
|
+
const ret = new Uint8Array(getArrayU8FromWasm0(arg0, arg1));
|
|
56
|
+
return ret;
|
|
57
|
+
},
|
|
36
58
|
__wbindgen_cast_0000000000000001: function(arg0, arg1) {
|
|
37
59
|
// Cast intrinsic for `Ref(String) -> Externref`.
|
|
38
60
|
const ret = getStringFromWasm0(arg0, arg1);
|
|
@@ -54,6 +76,11 @@ function __wbg_get_imports() {
|
|
|
54
76
|
};
|
|
55
77
|
}
|
|
56
78
|
|
|
79
|
+
function getArrayU8FromWasm0(ptr, len) {
|
|
80
|
+
ptr = ptr >>> 0;
|
|
81
|
+
return getUint8ArrayMemory0().subarray(ptr / 1, ptr / 1 + len);
|
|
82
|
+
}
|
|
83
|
+
|
|
57
84
|
function getStringFromWasm0(ptr, len) {
|
|
58
85
|
ptr = ptr >>> 0;
|
|
59
86
|
return decodeText(ptr, len);
|
|
Binary file
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
/* tslint:disable */
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
export const memory: WebAssembly.Memory;
|
|
4
|
-
export const
|
|
4
|
+
export const qr_png_bytes: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
|
|
5
|
+
export const qr_png_data_url: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
|
|
5
6
|
export const __wbindgen_externrefs: WebAssembly.Table;
|
|
6
7
|
export const __wbindgen_malloc: (a: number, b: number) => number;
|
|
7
8
|
export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
|
package/react/index.d.ts
CHANGED
|
@@ -1,6 +1,17 @@
|
|
|
1
|
-
|
|
1
|
+
export type QrEcc = "L" | "M" | "Q" | "H";
|
|
2
2
|
|
|
3
|
-
export
|
|
3
|
+
export interface UseQrPngOptions {
|
|
4
|
+
size?: number;
|
|
5
|
+
margin?: number;
|
|
6
|
+
ecc?: QrEcc;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export declare function useQrPngDataUrl(
|
|
10
|
+
text: string,
|
|
11
|
+
opts?: UseQrPngOptions
|
|
12
|
+
): string;
|
|
13
|
+
|
|
14
|
+
export declare function useQrPngBlobUrl(
|
|
4
15
|
text: string,
|
|
5
|
-
opts?:
|
|
16
|
+
opts?: UseQrPngOptions
|
|
6
17
|
): string;
|
package/react/index.js
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import { useEffect, useState } from "react";
|
|
2
|
-
import { qr_png_data_url } from "../index.web.js";
|
|
2
|
+
import { qr_png_data_url, qr_png_bytes } from "../index.web.js";
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* React hook for QR Code Data URL (browser-only).
|
|
6
|
+
* Backward-compatible, but heavier than Blob URL due to base64.
|
|
6
7
|
* @param {string} text
|
|
7
8
|
* @param {{size?:number, margin?:number, ecc?:"L"|"M"|"Q"|"H"}} [opts]
|
|
8
9
|
*/
|
|
9
|
-
export function
|
|
10
|
+
export function useQrPngDataUrl(text, opts) {
|
|
10
11
|
const size = opts?.size ?? 320;
|
|
11
12
|
const margin = opts?.margin ?? 4;
|
|
12
13
|
const ecc = opts?.ecc ?? "Q";
|
|
@@ -38,3 +39,53 @@ export function useQrCode(text, opts) {
|
|
|
38
39
|
|
|
39
40
|
return src;
|
|
40
41
|
}
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* React hook for QR Code as Blob URL (browser-only).
|
|
45
|
+
* Faster + lower memory than base64 data URL for frequent updates / large images.
|
|
46
|
+
* @param {string} text
|
|
47
|
+
* @param {{size?:number, margin?:number, ecc?:"L"|"M"|"Q"|"H"}} [opts]
|
|
48
|
+
*/
|
|
49
|
+
export function useQrPngBlobUrl(text, opts) {
|
|
50
|
+
const size = opts?.size ?? 320;
|
|
51
|
+
const margin = opts?.margin ?? 4;
|
|
52
|
+
const ecc = opts?.ecc ?? "Q";
|
|
53
|
+
|
|
54
|
+
const [src, setSrc] = useState("");
|
|
55
|
+
|
|
56
|
+
useEffect(() => {
|
|
57
|
+
let alive = true;
|
|
58
|
+
let objectUrl = "";
|
|
59
|
+
|
|
60
|
+
if (!text) {
|
|
61
|
+
setSrc("");
|
|
62
|
+
return () => {
|
|
63
|
+
alive = false;
|
|
64
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
qr_png_bytes(text, size, margin, ecc)
|
|
69
|
+
.then((bytes) => {
|
|
70
|
+
if (!alive) return;
|
|
71
|
+
|
|
72
|
+
// revoke old url (if any)
|
|
73
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
74
|
+
|
|
75
|
+
objectUrl = URL.createObjectURL(
|
|
76
|
+
new Blob([bytes], { type: "image/png" }),
|
|
77
|
+
);
|
|
78
|
+
setSrc(objectUrl);
|
|
79
|
+
})
|
|
80
|
+
.catch(() => {
|
|
81
|
+
if (alive) setSrc("");
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
return () => {
|
|
85
|
+
alive = false;
|
|
86
|
+
if (objectUrl) URL.revokeObjectURL(objectUrl);
|
|
87
|
+
};
|
|
88
|
+
}, [text, size, margin, ecc]);
|
|
89
|
+
|
|
90
|
+
return src;
|
|
91
|
+
}
|