@storm-ds/icons 1.0.0 → 1.0.1
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 +74 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,74 @@
|
|
|
1
|
-
# storm-icons
|
|
1
|
+
# @storm-ds/icons
|
|
2
|
+
|
|
3
|
+
486 clean, consistent SVG icons as React components. Designed for the Storm design system.
|
|
4
|
+
|
|
5
|
+
[Browse icons](https://storm-project-web.vercel.app/docs/icons)
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @storm-ds/icons
|
|
11
|
+
# or
|
|
12
|
+
pnpm add @storm-ds/icons
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### Peer dependencies
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add react
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```tsx
|
|
24
|
+
import { ArrowRight, Search, Settings } from '@storm-ds/icons'
|
|
25
|
+
|
|
26
|
+
export default function App() {
|
|
27
|
+
return (
|
|
28
|
+
<button>
|
|
29
|
+
Next <ArrowRight />
|
|
30
|
+
</button>
|
|
31
|
+
)
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Each icon accepts standard SVG props (`className`, `width`, `height`, `stroke`, etc.):
|
|
36
|
+
|
|
37
|
+
```tsx
|
|
38
|
+
<Search className="w-5 h-5 text-storm-muted-foreground" />
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Metadata
|
|
42
|
+
|
|
43
|
+
Access icon names and categories for building icon pickers or documentation:
|
|
44
|
+
|
|
45
|
+
```tsx
|
|
46
|
+
import { iconMetadata } from '@storm-ds/icons/metadata'
|
|
47
|
+
import type { IconName, IconCategory } from '@storm-ds/icons/metadata'
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
14 categories: Arrows & Navigation, Actions, Media, Communication, Files & Folders, Layout & UI, Shapes & Symbols, Commerce, Users & Social, Development, Weather & Nature, Charts & Data, Security, Misc.
|
|
51
|
+
|
|
52
|
+
### Raw SVGs
|
|
53
|
+
|
|
54
|
+
SVG files are also available directly:
|
|
55
|
+
|
|
56
|
+
```js
|
|
57
|
+
import icon from '@storm-ds/icons/svg/arrow-right.svg'
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Exports
|
|
61
|
+
|
|
62
|
+
| Entry point | Description |
|
|
63
|
+
|---|---|
|
|
64
|
+
| `@storm-ds/icons` | 486 React icon components |
|
|
65
|
+
| `@storm-ds/icons/metadata` | Icon names, categories, and tags |
|
|
66
|
+
| `@storm-ds/icons/svg/*` | Raw SVG files |
|
|
67
|
+
|
|
68
|
+
## Requirements
|
|
69
|
+
|
|
70
|
+
- React >= 18
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT
|