svg-dynamic-icon 1.0.0 → 1.0.2
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 +19 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
1
|
# svg-dynamic-icon
|
|
2
2
|
|
|
3
|
-
A lightweight React component for rendering **custom-made SVG icons** with **TailwindCSS** support.
|
|
4
|
-
Perfect for projects with a custom icon set, and you want dynamic usage without hardcoding imports.
|
|
3
|
+
- A lightweight React component for rendering **custom-made SVG icons** with **TailwindCSS** support.
|
|
4
|
+
- Perfect for projects with a custom icon set, and you want dynamic usage without hardcoding imports.
|
|
5
|
+
|
|
6
|
+
#
|
|
5
7
|
|
|
6
8
|
## 📦 Installation
|
|
7
9
|
|
|
@@ -9,6 +11,8 @@ Perfect for projects with a custom icon set, and you want dynamic usage without
|
|
|
9
11
|
npm install svg-dynamic-icon
|
|
10
12
|
```
|
|
11
13
|
|
|
14
|
+
#
|
|
15
|
+
|
|
12
16
|
## 🚀 Usage
|
|
13
17
|
|
|
14
18
|
```bash
|
|
@@ -25,28 +29,25 @@ function Example() {
|
|
|
25
29
|
}
|
|
26
30
|
```
|
|
27
31
|
|
|
32
|
+
#
|
|
33
|
+
|
|
28
34
|
## 📁 Icon Setup
|
|
29
35
|
|
|
30
36
|
- Place your SVG icons in the /assets/icons/ folder.
|
|
31
37
|
- File names must match the iconName prop exactly (MyIcon.svg → iconName="MyIcon").
|
|
32
38
|
- Upload square-shaped icons for best rendering (e.g., 24x24 or 64x64).
|
|
33
39
|
|
|
34
|
-
|
|
40
|
+
#
|
|
35
41
|
|
|
36
|
-
|
|
37
|
-
iconName | string | ✅ | Name of the SVG icon file (without .svg) located in /assets/icons/
|
|
38
|
-
size | number | ❌ | Icon size in pixels (width & height). Default: 25
|
|
39
|
-
color | string | ❌ | TailwindCSS text color class (e.g., text-white, text-gray-500)
|
|
42
|
+
## ⚙️ Props
|
|
40
43
|
|
|
41
|
-
|
|
44
|
+
| **Prop** | **Type** | **Required** | **Description** |
|
|
45
|
+
| :------- | :------- | :----------- | :----------------------------------------------------------------- |
|
|
46
|
+
| iconName | string | yes | Name of the SVG icon file (without .svg) located in /assets/icons/ |
|
|
47
|
+
| size | number | no | Icon size in pixels (width & height). Default: 25 |
|
|
48
|
+
| color | string | no | TailwindCSS text color class (e.g., text-white, text-gray-500) |
|
|
42
49
|
|
|
43
|
-
|
|
44
|
-
├── assets/
|
|
45
|
-
│....└── icons/
|
|
46
|
-
│.........├── Checkmark.svg
|
|
47
|
-
│.........└── Close.svg
|
|
48
|
-
├── App.tsx
|
|
49
|
-
└── ...
|
|
50
|
+
#
|
|
50
51
|
|
|
51
52
|
## 🧩 Built With
|
|
52
53
|
|
|
@@ -54,6 +55,8 @@ project-root/
|
|
|
54
55
|
- react-svg
|
|
55
56
|
- tailwind-merge
|
|
56
57
|
|
|
57
|
-
|
|
58
|
+
#
|
|
59
|
+
|
|
60
|
+
## 📝 License
|
|
58
61
|
|
|
59
62
|
MIT
|