partycles 1.1.3 → 1.1.4
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 +55 -24
- package/dist/animations/animations/index.d.ts.map +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +14 -3
package/README.md
CHANGED
@@ -12,11 +12,11 @@ A lightweight, performant React library for adding delightful animation effects
|
|
12
12
|
## ✨ Features
|
13
13
|
|
14
14
|
- 🎯 **Simple API** - Just one hook to rule them all
|
15
|
-
- 🎨 **
|
15
|
+
- 🎨 **19 Beautiful Animations** - Confetti, sparkles, hearts, stars, fireworks, bubbles, snow, emoji, coins, petals, aurora, fireflies, paint, balloons, galaxy, glitch, magicdust, crystals, and leaves
|
16
16
|
- 📦 **Tiny Bundle** - Zero dependencies, optimized for performance
|
17
17
|
- 🚀 **Performant** - Optimized animations using requestAnimationFrame
|
18
18
|
- 🎮 **Full Control** - Customize colors, particle count, physics, and more
|
19
|
-
- 📱 **
|
19
|
+
- 📱 **Mobile Optimized** - Automatic performance optimizations for mobile devices
|
20
20
|
- 🔧 **TypeScript Support** - Fully typed for excellent DX
|
21
21
|
- ⚡ **React 18 Ready** - Built with the latest React features
|
22
22
|
|
@@ -52,7 +52,7 @@ That's it! No configuration needed - it just works. 🎊
|
|
52
52
|
|
53
53
|
- **Zero Dependencies** - No bloat, just pure React code
|
54
54
|
- **One Hook** - Simple `useReward` hook handles everything
|
55
|
-
- **
|
55
|
+
- **19 Animations** - From confetti to magical effects, we've got you covered
|
56
56
|
- **Fully Typed** - Great TypeScript support out of the box
|
57
57
|
- **Customizable** - Tweak colors, physics, particle count, and more
|
58
58
|
- **Performant** - Optimized animations that won't slow down your app
|
@@ -66,7 +66,7 @@ The main hook for creating reward animations.
|
|
66
66
|
#### Parameters
|
67
67
|
|
68
68
|
- `elementId` (string): The ID of the element to animate from
|
69
|
-
- `animationType` (string): One of: `'confetti'`, `'sparkles'`, `'hearts'`, `'stars'`, `'fireworks'`, `'bubbles'`, `'snow'`, `'emoji'`, `'coins'`, `'
|
69
|
+
- `animationType` (string): One of: `'confetti'`, `'sparkles'`, `'hearts'`, `'stars'`, `'fireworks'`, `'bubbles'`, `'snow'`, `'emoji'`, `'coins'`, `'petals'`, `'aurora'`, `'fireflies'`, `'paint'`, `'balloons'`, `'galaxy'`, `'glitch'`, `'magicdust'`, `'crystals'`, `'leaves'`
|
70
70
|
- `config` (optional): Animation configuration object
|
71
71
|
|
72
72
|
#### Returns
|
@@ -202,16 +202,6 @@ const { reward } = useReward('buttonId', 'coins', {
|
|
202
202
|
});
|
203
203
|
```
|
204
204
|
|
205
|
-
### Lightning ⚡
|
206
|
-
Electric energy bursts for powerful actions.
|
207
|
-
|
208
|
-
```tsx
|
209
|
-
const { reward } = useReward('buttonId', 'lightning', {
|
210
|
-
particleCount: 20,
|
211
|
-
spread: 360
|
212
|
-
});
|
213
|
-
```
|
214
|
-
|
215
205
|
### Petals 🌸
|
216
206
|
Delicate flower petals floating in the wind.
|
217
207
|
|
@@ -252,16 +242,6 @@ const { reward } = useReward('buttonId', 'paint', {
|
|
252
242
|
});
|
253
243
|
```
|
254
244
|
|
255
|
-
### Music 🎵
|
256
|
-
Musical notes floating upward.
|
257
|
-
|
258
|
-
```tsx
|
259
|
-
const { reward } = useReward('buttonId', 'music', {
|
260
|
-
particleCount: 20,
|
261
|
-
physics: { gravity: -0.08 }
|
262
|
-
});
|
263
|
-
```
|
264
|
-
|
265
245
|
### Balloons 🎈
|
266
246
|
Floating balloons with realistic physics.
|
267
247
|
|
@@ -282,6 +262,46 @@ const { reward } = useReward('buttonId', 'galaxy', {
|
|
282
262
|
});
|
283
263
|
```
|
284
264
|
|
265
|
+
### Glitch 📺
|
266
|
+
Digital glitch effect for tech themes.
|
267
|
+
|
268
|
+
```tsx
|
269
|
+
const { reward } = useReward('buttonId', 'glitch', {
|
270
|
+
particleCount: 30,
|
271
|
+
elementSize: 40
|
272
|
+
});
|
273
|
+
```
|
274
|
+
|
275
|
+
### Magic Dust ✨
|
276
|
+
Magical sparkling dust particles.
|
277
|
+
|
278
|
+
```tsx
|
279
|
+
const { reward } = useReward('buttonId', 'magicdust', {
|
280
|
+
particleCount: 35,
|
281
|
+
colors: ['#9c27b0', '#673ab7', '#3f51b5']
|
282
|
+
});
|
283
|
+
```
|
284
|
+
|
285
|
+
### Crystals 💎
|
286
|
+
Shimmering crystal fragments.
|
287
|
+
|
288
|
+
```tsx
|
289
|
+
const { reward } = useReward('buttonId', 'crystals', {
|
290
|
+
particleCount: 20,
|
291
|
+
elementSize: 25
|
292
|
+
});
|
293
|
+
```
|
294
|
+
|
295
|
+
### Leaves 🍃
|
296
|
+
Falling autumn leaves with natural movement.
|
297
|
+
|
298
|
+
```tsx
|
299
|
+
const { reward } = useReward('buttonId', 'leaves', {
|
300
|
+
particleCount: 30,
|
301
|
+
physics: { gravity: 0.05, wind: 0.2 }
|
302
|
+
});
|
303
|
+
```
|
304
|
+
|
285
305
|
## 💡 Examples
|
286
306
|
|
287
307
|
### Form Submission Success
|
@@ -448,6 +468,17 @@ We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) f
|
|
448
468
|
4. Push to the branch (`git push origin feature/amazing-feature`)
|
449
469
|
5. Open a Pull Request
|
450
470
|
|
471
|
+
## 📈 Changelog
|
472
|
+
|
473
|
+
### v1.1.3 (Latest)
|
474
|
+
- 🚀 Added automatic mobile performance optimizations
|
475
|
+
- 🐛 Fixed Safari compatibility issues
|
476
|
+
- 📦 Streamlined bundle size by removing 7 animations
|
477
|
+
- 🔧 Fixed CI/CD pipeline and npm publishing
|
478
|
+
|
479
|
+
### v1.0.0
|
480
|
+
- 🎉 Initial release with 26 animations
|
481
|
+
|
451
482
|
## 📄 License
|
452
483
|
|
453
484
|
MIT © Jonathan Leane
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/animations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/animations/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAsBpE,MAAM,MAAM,eAAe,GAAG,CAC5B,MAAM,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,EAChC,MAAM,EAAE,eAAe,KACpB,QAAQ,EAAE,CAAC;AAChB,MAAM,MAAM,gBAAgB,GAAG,CAAC,QAAQ,EAAE,QAAQ,KAAK,KAAK,CAAC,SAAS,CAAC;AAEvE,UAAU,gBAAgB;IACxB,eAAe,EAAE,eAAe,CAAC;IACjC,cAAc,EAAE,gBAAgB,CAAC;CAClC;AAED,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,aAAa,EAAE,gBAAgB,CA6E9D,CAAC"}
|