Skip to content

Commit b305528

Browse files
committed
chore: update
1 parent 4736265 commit b305528

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

CHANGELOG.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,28 @@ This release represents a complete transformation of the React QR Code library,
1111
### ✨ New Features
1212

1313
#### Advanced QR Code Component
14+
1415
- **NEW: `AdvancedQRCode` component** with 100+ customization options
1516
- **25+ Preset Themes**: Professional designs including minimal, gradient, ocean, sunset, forest, neon, cyberpunk, retrowave, and more
1617
- **12+ Eye Shapes**: square, circle, rounded, leaf, star, diamond, flower, heart, octagon, hexagon, cross, gear
1718
- **18+ Body Shapes**: square, circle, rounded, diamond, star, hexagon, octagon, triangle, cross, plus, dots, lines, zigzag, waves, noise, circuit, organic, fluid
1819
- **12+ Background Patterns**: dots, lines, grid, mesh, circuit, waves, noise, gradient, radial, hexagon, triangle
1920

2021
#### Gradient Support
22+
2123
- **Linear Gradients**: Customizable angle and color stops
2224
- **Radial Gradients**: Center point and radius control
2325
- **Conic Gradients**: Angular color transitions
2426
- **Mesh Gradients**: Advanced multi-point gradients
2527

2628
#### Animation & Effects
29+
2730
- **Animation Types**: fade-in, scale, rotate, slide, bounce, pulse, wave, ripple
2831
- **Visual Effects**: shadow, glow, blur, 3D, emboss, neon, metallic, glass, chrome, holographic
2932
- **Particle Animations**: Configurable particle effects with custom shapes and directions
3033

3134
#### QR Code Templates
35+
3236
- **WiFi Networks**: Auto-connect QR codes with WPA/WPA2/WEP support
3337
- **vCard Contacts**: Complete contact information including organization
3438
- **SMS Messages**: Pre-filled text messages
@@ -38,12 +42,14 @@ This release represents a complete transformation of the React QR Code library,
3842
- **Cryptocurrency**: Bitcoin and Ethereum payment QR codes
3943

4044
#### Accessibility & UX
45+
4146
- **Color Blind Modes**: Support for protanopia, deuteranopia, tritanopia, and monochrome
4247
- **High Contrast Mode**: Ensures QR code detectability
4348
- **ARIA Support**: Full keyboard navigation and screen reader compatibility
4449
- **Download & Copy**: Built-in functionality for saving and clipboard operations
4550

4651
#### Developer Experience
52+
4753
- **TypeScript Strict Mode**: Complete type safety with comprehensive interfaces
4854
- **Tree-Shakable**: Optimized bundle size with ESM support
4955
- **React 18+ Support**: Hooks, forwardRef, and concurrent features
@@ -52,18 +58,21 @@ This release represents a complete transformation of the React QR Code library,
5258
### 🔧 Improvements
5359

5460
#### Code Quality
61+
5562
- **ES6+ Classes**: Migrated from function constructors to modern class syntax
5663
- **React Hooks**: Implemented useMemo, useCallback, useRef for performance
5764
- **Memoization**: Optimized re-renders with React.memo and useMemo
5865
- **Code Splitting**: Lazy loading for advanced features
5966

6067
#### Testing
68+
6169
- **100% Test Coverage**: Comprehensive unit tests for all components
6270
- **E2E Testing**: Puppeteer-based detectability tests
6371
- **QR Validation**: Built-in decoder for testing generated QR codes
6472
- **Visual Regression**: Screenshot-based testing for all themes
6573

6674
#### Documentation
75+
6776
- **Interactive Examples**: Live demos with 100+ variations
6877
- **API Documentation**: Complete TypeScript interfaces and prop documentation
6978
- **Usage Guides**: Step-by-step tutorials for common use cases
@@ -88,7 +97,7 @@ This release represents a complete transformation of the React QR Code library,
8897

8998
- **Minimum React Version**: Now requires React 16.8+ (hooks support)
9099
- **Import Path Changes**: Advanced types now imported from `@devmehq/react-qr-code`
91-
- **Prop Renames**:
100+
- **Prop Renames**:
92101
- `bgColor``backgroundColor`
93102
- `fgColor``color` or use theme system
94103
- `includeMargin``margin` (number value)
@@ -98,22 +107,24 @@ This release represents a complete transformation of the React QR Code library,
98107
#### From v1.x to v2.0
99108

100109
**Basic Usage (no changes required):**
110+
101111
```tsx
102112
// Still works as before
103113
<ReactQrCode value="https://example.com" />
104114
```
105115

106116
**Advanced Features (new component):**
117+
107118
```tsx
108119
// OLD (v1.x)
109-
<ReactQrCode
120+
<ReactQrCode
110121
value="https://example.com"
111122
bgColor="#ffffff"
112123
fgColor="#000000"
113124
/>
114125

115126
// NEW (v2.0) - Basic
116-
<ReactQrCode
127+
<ReactQrCode
117128
value="https://example.com"
118129
backgroundColor="#ffffff"
119130
color="#000000"

RELEASE_NOTES.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@ We're thrilled to announce the release of React QR Code v2.0, a complete reimagi
77
## 🎯 Key Highlights
88

99
### 🎨 100+ Customization Options
10+
1011
Transform boring black and white QR codes into stunning visual elements that match your brand:
12+
1113
- **25+ professionally designed preset themes**
1214
- **12+ eye shapes** and **18+ body shapes**
1315
- **Advanced gradients** including linear, radial, conic, and mesh
1416
- **Animated effects** with particle systems
1517

1618
### 🧩 New Advanced Component
19+
1720
```tsx
1821
<AdvancedQRCode
1922
value="https://your-site.com"
@@ -25,7 +28,9 @@ Transform boring black and white QR codes into stunning visual elements that mat
2528
```
2629

2730
### 📱 QR Code Templates
31+
2832
Generate specialized QR codes with built-in helpers:
33+
2934
```tsx
3035
// WiFi auto-connect
3136
<AdvancedQRCode value={QRHelpers.wifi('Network', 'pass123', 'WPA2')} />
@@ -38,11 +43,13 @@ Generate specialized QR codes with built-in helpers:
3843
```
3944

4045
### ♿ Accessibility First
46+
4147
- **Color blind modes** for all types of color vision deficiency
4248
- **High contrast mode** ensuring 7:1+ contrast ratios
4349
- **Full ARIA support** with keyboard navigation
4450

4551
### 🚀 Performance Improvements
52+
4653
- **50% faster** generation with optimized algorithms
4754
- **30% smaller** bundle size with tree-shaking
4855
- **React 18** concurrent features support
@@ -59,12 +66,14 @@ yarn add @devmehq/react-qr-code@2.0.0
5966
## 🔄 Migration from v1.x
6067

6168
### No Breaking Changes for Basic Usage
69+
6270
```tsx
6371
// This still works exactly as before!
6472
<ReactQrCode value="https://example.com" />
6573
```
6674

6775
### Enhanced with New Features
76+
6877
```tsx
6978
// Use the new advanced component for more options
7079
<AdvancedQRCode
@@ -84,13 +93,15 @@ yarn add @devmehq/react-qr-code@2.0.0
8493
## 📸 Visual Examples
8594

8695
### Preset Themes
87-
| Minimal | Ocean | Sunset | Neon |
88-
|---------|-------|--------|------|
96+
97+
| Minimal | Ocean | Sunset | Neon |
98+
| --------- | ---------- | -------------- | ----------- |
8999
| Clean B&W | Deep blues | Warm gradients | Cyber green |
90100

91101
### Custom Shapes
92-
| Circle | Diamond | Star | Fluid |
93-
|--------|---------|------|-------|
102+
103+
| Circle | Diamond | Star | Fluid |
104+
| ----------- | ------------ | -------------- | ------------ |
94105
| Smooth dots | Sharp angles | Stellar design | Organic flow |
95106

96107
## 🧪 What's Been Tested
@@ -104,6 +115,7 @@ yarn add @devmehq/react-qr-code@2.0.0
104115
## 🎉 Community Contributions
105116

106117
This release wouldn't have been possible without the amazing feedback from our community:
118+
107119
- Special thanks for detectability testing and contrast ratio feedback
108120
- UI/UX suggestions that shaped the preset themes
109121
- Performance optimization ideas
@@ -119,6 +131,7 @@ This release wouldn't have been possible without the amazing feedback from our c
119131
## 🐛 Report Issues
120132

121133
Found a bug or have a feature request? Please let us know:
134+
122135
- **[GitHub Issues](https://github.com/devmehq/react-qr-code/issues)**
123136
- **[Discussions](https://github.com/devmehq/react-qr-code/discussions)**
124137

@@ -131,4 +144,4 @@ Happy coding! 🎨✨
131144
---
132145

133146
**The React QR Code Team**
134-
[DEV.ME](https://dev.me)
147+
[DEV.ME](https://dev.me)

0 commit comments

Comments
 (0)