@qr-styled/node 1.1.0 → 1.1.1

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.
Files changed (2) hide show
  1. package/README.md +55 -5
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -17,7 +17,7 @@ A powerful Node.js/TypeScript library for generating QR codes with advanced styl
17
17
  - 🖼️ **Logo Support**: Add logos with circular or square backgrounds
18
18
  - � **Specialized QR Types**: vCard, WiFi, Email, SMS, Geo location
19
19
  - 📄 **SVG Export**: Vector format for perfect scalability
20
- - 👁️ **Eye Customization**: Custom colors and shapes for finder patterns
20
+ - 👁️ **Eye Customization**: Custom colors and shapes (square, rounded, or circular) ✨
21
21
  - 📏 **Proper Margins**: Standard QR quiet zone support
22
22
  - 📦 **Multiple Output Formats**: PNG, JPEG, SVG, Buffer, Data URL, or Canvas
23
23
  - 🛠️ **CLI & API**: Use from command line or programmatically
@@ -138,6 +138,55 @@ A powerful Node.js/TypeScript library for generating QR codes with advanced styl
138
138
  </td>
139
139
  </tr>
140
140
  </table>
141
+ ### Circular Eyes ✨ NEW
142
+
143
+ Experience modern QR codes with perfectly smooth circular finder patterns instead of traditional squares.
144
+
145
+ <table>
146
+ <tr>
147
+ <td align="center" valign="top">
148
+ <img src="https://raw.githubusercontent.com/Luisma92/qr-styled/main/packages/node/docs/images/circular-eyes-simple.png" width="180" alt="Simple Circular Eyes QR"/>
149
+ <br/>
150
+ <b>Simple Circular</b>
151
+ <br/>
152
+ <sub>Blue circular eyes with rounded modules</sub>
153
+ </td>
154
+ <td align="center" valign="top">
155
+ <img src="https://raw.githubusercontent.com/Luisma92/qr-styled/main/packages/node/docs/images/circular-eyes-gradient.png" width="180" alt="Gradient Circular Eyes QR"/>
156
+ <br/>
157
+ <b>Gradient Circular</b>
158
+ <br/>
159
+ <sub>Pink gradient with circular eyes</sub>
160
+ </td>
161
+ <td align="center" valign="top">
162
+ <img src="https://raw.githubusercontent.com/Luisma92/qr-styled/main/packages/node/docs/images/circular-eyes-contrast.png" width="180" alt="High Contrast Circular Eyes QR"/>
163
+ <br/>
164
+ <b>High Contrast</b>
165
+ <br/>
166
+ <sub>Pink circular eyes on dark modules</sub>
167
+ </td>
168
+ </tr>
169
+ </table>
170
+
171
+ ```typescript
172
+ // Simple circular eyes
173
+ const qr = new QRGenerator({
174
+ url: 'https://example.com',
175
+ eyeColor: '#1e40af',
176
+ eyeShape: 'circle', // ✨ NEW: 'square' | 'rounded' | 'circle'
177
+ rounded: true
178
+ });
179
+
180
+ // Gradient with circular eyes
181
+ const gradientQR = new QRGenerator({
182
+ url: 'https://example.com',
183
+ gradient: true,
184
+ gradientColors: '#f093fb, #f5576c',
185
+ eyeColor: '#c2185b',
186
+ eyeShape: 'circle',
187
+ rounded: true
188
+ });
189
+ ```
141
190
 
142
191
  > 💡 **Tip**: All examples shown above were generated with this library! Check the [`examples/`](examples/) directory for source code.
143
192
 
@@ -252,10 +301,11 @@ await generateQRToFile(
252
301
 
253
302
  #### Eye Customization
254
303
 
255
- | Option | Type | Default | Description |
256
- | ----------- | -------- | ------- | --------------------------------- |
257
- | `eyeColor` | `string` | `''` | Custom eye (finder pattern) color |
258
- | `eyeRadius` | `number` | `0` | Eye corner radius (0.0 - 0.5) |
304
+ | Option | Type | Default | Description |
305
+ | ----------- | -------- | ---------- | ---------------------------------------------------- |
306
+ | `eyeColor` | `string` | `''` | Custom eye (finder pattern) color |
307
+ | `eyeRadius` | `number` | `0` | Eye corner radius (0.0 - 0.5) |
308
+ | `eyeShape` | `string` | `'square'` | Eye shape: `'square'`, `'rounded'`, or `'circle'` ✨ |
259
309
 
260
310
  #### Gradient Options
261
311
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@qr-styled/node",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "A professional Node.js QR code generator library with advanced styling options including gradients, rounded modules, logo support, specialized QR types (vCard, WiFi, Email, SMS, Geo), SVG export, eye customization, and circular eyes",
5
5
  "main": "./dist/index.js",
6
6
  "type": "module",