@hugeicons/core-free-icons 1.0.16 → 1.1.0

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 CHANGED
@@ -1,17 +1,18 @@
1
1
  # @hugeicons/core-free-icons
2
2
 
3
- > HugeIcons Core Free Icons Package - Beautiful and customizable icons for your applications
3
+ > Hugeicons Core Free Icons Package - Beautiful and customizable icons for your applications
4
4
 
5
5
  ![31c9262e-aeea-4403-9086-3c8b88885cab](https://github.com/hugeicons/hugeicons-react/assets/130147052/ff91f2f0-095a-4c6d-8942-3af4759f9021)
6
6
 
7
- ## What is HugeIcons?
7
+ ## What is Hugeicons?
8
8
 
9
- HugeIcons is a comprehensive icon library designed for modern web and mobile applications. The free package includes 4,000+ carefully crafted icons in the Stroke Rounded style, while the pro version offers over 36,000 icons across 9 unique styles.
9
+ Hugeicons is a comprehensive icon library designed for modern web and mobile applications. The free package includes 4,500+ carefully crafted icons in the Stroke Rounded style, while the pro version offers over 40,000+ icons across 9 unique styles.
10
10
 
11
11
  ### Key Highlights
12
- - **4,000+ Free Icons**: Extensive collection of Stroke Rounded icons covering essential UI elements, actions, and concepts
12
+ - **4,500+ Free Icons**: Extensive collection of Stroke Rounded icons covering essential UI elements, actions, and concepts
13
13
  - **Pixel Perfect**: Every icon is crafted on a 24x24 pixel grid ensuring crisp, clear display at any size
14
14
  - **Customizable**: Easily adjust colors, sizes, and styles to match your design needs
15
+ - **Optimized Loading**: New individual icon imports reduce bundle size by 99%
15
16
  - **Regular Updates**: New icons added regularly to keep up with evolving design trends
16
17
 
17
18
  > 📚 **Looking for Pro Icons?** Check out our comprehensive documentation at [docs.hugeicons.com](https://docs.hugeicons.com) for detailed information about pro icons, styles, and advanced usage.
@@ -40,26 +41,59 @@ npm install @hugeicons/svelte # for Svelte
40
41
 
41
42
  ## Usage
42
43
 
43
- This package provides the core icons. Here's how to import from the core package:
44
+ ### Import Methods
45
+
46
+ This package now supports multiple import methods for maximum flexibility:
47
+
48
+ #### 1. Static Import (Tree-shakeable)
49
+ Best for production builds when you know which icons you need:
50
+
51
+ ```javascript
52
+ import { Home01Icon, User01Icon } from '@hugeicons/core-free-icons';
53
+ ```
54
+
55
+ #### 2. Dynamic Import - Full Bundle
56
+ Loads the entire icon library (use when you need many icons dynamically):
44
57
 
45
58
  ```javascript
46
- // Import directly from core package
47
- import { HomeIcon } from '@hugeicons/core-free-icons';
59
+ const { Home01Icon } = await import('@hugeicons/core-free-icons');
48
60
  ```
49
61
 
62
+ #### 3. Dynamic Import - Individual Icons (NEW ✨)
63
+ Loads only the specific icon you need (99% smaller bundle size):
64
+
65
+ ```javascript
66
+ // Loads just ~0.75KB instead of ~5MB!
67
+ const icon = await import('@hugeicons/core-free-icons/Home01Icon');
68
+ const Home01Icon = icon.default;
69
+ ```
70
+
71
+ ### Performance Comparison
72
+
73
+ | Import Method | Bundle Size | Load Time | Best For |
74
+ |--------------|-------------|-----------|----------|
75
+ | Static Import | ~2-3KB per icon | 0ms (bundled) | Production builds |
76
+ | Dynamic Full Bundle | ~5MB | 100-200ms | Many dynamic icons |
77
+ | Dynamic Individual | ~0.75KB | 10-20ms | Icon pickers, lazy loading |
78
+
50
79
  For real-world applications, we recommend using our framework-specific packages that provide optimized components and additional features. Check out the Framework Support section below for more details.
51
80
 
52
81
  ## Features
53
82
 
54
- - Modern, high-quality SVG icons
55
- - Tree-shakeable - only import what you use
56
- - TypeScript support
57
- - ESM and CommonJS support
58
- - Side-effect free
83
+ - 🎯 **Individual Icon Imports**: Load only what you need with 99% bundle size reduction
84
+ - 🌳 **Tree-shakeable**: Optimized for modern bundlers
85
+ - 📦 **Multiple Import Methods**: Static, dynamic bundle, or dynamic individual
86
+ - 🔷 **TypeScript Support**: Full type definitions included
87
+ - 📱 **Framework Agnostic**: Works with any JavaScript framework
88
+ - ⚡ **Optimized Performance**: Lazy load icons on demand
89
+ - 🎨 **Customizable**: Easy to style with CSS or inline styles
90
+ - ✅ **ESM & CommonJS**: Support for both module systems
91
+ - 🚀 **Zero Dependencies**: No external dependencies
92
+ - 🔄 **Regular Updates**: New icons added frequently
59
93
 
60
94
  ## Framework Support
61
95
 
62
- HugeIcons provides dedicated packages for various frameworks:
96
+ Hugeicons provides dedicated packages for various frameworks:
63
97
  - [@hugeicons/react](https://www.npmjs.com/package/@hugeicons/react) - For React applications
64
98
  - [@hugeicons/react-native](https://www.npmjs.com/package/@hugeicons/react-native) - For React Native applications
65
99
  - [@hugeicons/vue](https://www.npmjs.com/package/@hugeicons/vue) - For Vue applications