blode-icons-react 0.3.1 → 0.3.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 +56 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<h3 align="center">blode-icons-react</h3>
|
|
2
|
+
<p align="center">3,000+ icons for React — drop-in lucide-react replacement.</p>
|
|
3
|
+
|
|
4
|
+
<p align="center">
|
|
5
|
+
<a href="https://www.npmjs.com/package/blode-icons-react"><img alt="npm version" src="https://img.shields.io/npm/v/blode-icons-react"></a>
|
|
6
|
+
<a href="https://github.com/mblode/blode-icons/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/License-MIT-yellow.svg"></a>
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
## Highlights
|
|
10
|
+
|
|
11
|
+
- **Drop-in replacement:** swap `lucide-react` imports with zero code changes
|
|
12
|
+
- **Tree-shakeable:** only ship the icons you use
|
|
13
|
+
- **Dynamic imports:** load icons by name at runtime
|
|
14
|
+
- **Lucide-compatible props:** `size`, `color`, and `strokeWidth` work out of the box
|
|
15
|
+
|
|
16
|
+
## Install
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install blode-icons-react
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```tsx
|
|
25
|
+
import { Airplane } from "blode-icons-react"
|
|
26
|
+
|
|
27
|
+
export default function App() {
|
|
28
|
+
return <Airplane size={32} color="#0066ff" />
|
|
29
|
+
}
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
### Tree-shaking import
|
|
33
|
+
|
|
34
|
+
```tsx
|
|
35
|
+
import Airplane from "blode-icons-react/icons/airplane"
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Dynamic icon
|
|
39
|
+
|
|
40
|
+
```tsx
|
|
41
|
+
import { DynamicIcon } from "blode-icons-react/dynamic"
|
|
42
|
+
|
|
43
|
+
<DynamicIcon name="airplane" size={24} />
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Props
|
|
47
|
+
|
|
48
|
+
All icons accept standard SVG attributes plus:
|
|
49
|
+
|
|
50
|
+
- `size` — width and height in pixels (default: `24`)
|
|
51
|
+
- `color` — stroke/fill color (default: `"currentColor"`)
|
|
52
|
+
- `strokeWidth` — stroke width (default: `2`)
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
[MIT](https://github.com/mblode/blode-icons/blob/main/LICENSE)
|