@central-icons-react/all 0.0.33 → 0.0.36

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
@@ -37,7 +37,9 @@ pnpm add @central-icons-react/all
37
37
 
38
38
  ## Usage
39
39
 
40
- Icons can be imported individually to keep your bundle size minimal (recommended):
40
+ ### Individual Imports (Recommended)
41
+
42
+ Icons can be imported individually to keep your bundle size minimal:
41
43
 
42
44
  ```jsx
43
45
  import { IconHome } from "@central-icons-react/round-filled-radius-0-stroke-1/IconHome";
@@ -47,6 +49,25 @@ function MyComponent() {
47
49
  }
48
50
  ```
49
51
 
52
+ ### Import alias
53
+
54
+ If you want to have a bit cleaner imports (and you are just using one icon type), you can use import aliases
55
+ (Requires npm at least v6.9.0 or yarn)
56
+
57
+ ```bash
58
+ npm install central-icons@npm:@central-icons-react/round-filled-radius-0-stroke-1
59
+ ```
60
+
61
+ ```jsx
62
+ import { IconHome } from "central-icons/IconHome";
63
+
64
+ function MyComponent() {
65
+ return <IconHome />;
66
+ }
67
+ ```
68
+
69
+ ### Central Icon Component
70
+
50
71
  Or you can import from the main entry point (not recommended to be used in production, loads all icons):
51
72
 
52
73
  ```jsx
@@ -65,18 +86,6 @@ function MyComponent() {
65
86
  }
66
87
  ```
67
88
 
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
89
  ## Icon Properties
81
90
 
82
91
  All icons accept the following properties: