@central-icons-react/all 0.0.33 → 0.0.37

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,6 +1,7 @@
1
1
  # @central-icons-react/all
2
2
 
3
3
  A comprehensive collection of professionally designed React icons featuring customizable styles including round and square shapes, filled and outlined variants, multiple stroke widths, and corner radius options.
4
+ The collection contains _icon_count_ icons with _variant_count_ variants in total.
4
5
 
5
6
  ## Table of Contents
6
7
 
@@ -37,7 +38,9 @@ pnpm add @central-icons-react/all
37
38
 
38
39
  ## Usage
39
40
 
40
- Icons can be imported individually to keep your bundle size minimal (recommended):
41
+ ### Individual Imports (Recommended)
42
+
43
+ Icons can be imported individually to keep your bundle size minimal:
41
44
 
42
45
  ```jsx
43
46
  import { IconHome } from "@central-icons-react/round-filled-radius-0-stroke-1/IconHome";
@@ -47,6 +50,25 @@ function MyComponent() {
47
50
  }
48
51
  ```
49
52
 
53
+ ### Import alias
54
+
55
+ If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
56
+ (Requires npm at least v6.9.0 or yarn)
57
+
58
+ ```bash
59
+ npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1
60
+ ```
61
+
62
+ ```jsx
63
+ import { IconHome } from "central-icons/IconHome";
64
+
65
+ function MyComponent() {
66
+ return <IconHome />;
67
+ }
68
+ ```
69
+
70
+ ### Central Icon Component
71
+
50
72
  Or you can import from the main entry point (not recommended to be used in production, loads all icons):
51
73
 
52
74
  ```jsx
@@ -65,18 +87,6 @@ function MyComponent() {
65
87
  }
66
88
  ```
67
89
 
68
- If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
69
-
70
- `npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1`
71
-
72
- ```jsx
73
- import { IconHome } from "central-icons/IconHome";
74
-
75
- function MyComponent() {
76
- return <IconHome />;
77
- }
78
- ```
79
-
80
90
  ## Icon Properties
81
91
 
82
92
  All icons accept the following properties: