@storm-ds/icons 0.1.0 → 0.1.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 +20 -17
- package/package.json +19 -9
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @storm-ds/icons
|
|
2
2
|
|
|
3
|
-
Simple, clean icon set for modern web apps.
|
|
3
|
+
Simple, clean icon set for modern web apps — 486 icons.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm install storm-icons
|
|
8
|
+
npm install @storm-ds/icons
|
|
9
9
|
# or
|
|
10
|
-
pnpm add storm-icons
|
|
10
|
+
pnpm add @storm-ds/icons
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Usage
|
|
@@ -28,29 +28,32 @@ export default function MyComponent() {
|
|
|
28
28
|
}
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
All icons accept standard SVG props (`className`, `style`, `width`, `height`, etc.) and forward refs.
|
|
32
32
|
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
### Raw SVG
|
|
34
|
+
|
|
35
|
+
For non-React frameworks (Astro, Vue, Svelte, etc.):
|
|
36
|
+
|
|
37
|
+
```js
|
|
35
38
|
import arrowRight from '@storm-ds/icons/svg/arrow-right.svg'
|
|
36
39
|
```
|
|
37
40
|
|
|
38
|
-
|
|
41
|
+
### Metadata
|
|
39
42
|
|
|
40
|
-
|
|
43
|
+
Access the full icon list programmatically:
|
|
41
44
|
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
```
|
|
45
|
+
```tsx
|
|
46
|
+
import { iconMeta } from '@storm-ds/icons/metadata'
|
|
45
47
|
|
|
46
|
-
|
|
48
|
+
// iconMeta: Array<{ name: string, componentName: string, keywords: string[] }>
|
|
49
|
+
```
|
|
47
50
|
|
|
48
|
-
## Icon
|
|
51
|
+
## Icon Specs
|
|
49
52
|
|
|
50
53
|
- 24x24 viewBox
|
|
51
|
-
-
|
|
52
|
-
-
|
|
53
|
-
-
|
|
54
|
+
- `currentColor` for strokes/fills
|
|
55
|
+
- 2px stroke width
|
|
56
|
+
- Kebab-case filenames
|
|
54
57
|
|
|
55
58
|
## License
|
|
56
59
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@storm-ds/icons",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Simple, clean icon set for modern web apps",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -19,11 +19,27 @@
|
|
|
19
19
|
"./svg/*": "./svg/*.svg"
|
|
20
20
|
},
|
|
21
21
|
"sideEffects": false,
|
|
22
|
+
"repository": {
|
|
23
|
+
"type": "git",
|
|
24
|
+
"url": "https://github.com/saayym/storm-project.git",
|
|
25
|
+
"directory": "packages/icons"
|
|
26
|
+
},
|
|
27
|
+
"homepage": "https://storm-project-web.vercel.app/docs/icons",
|
|
28
|
+
"bugs": {
|
|
29
|
+
"url": "https://github.com/saayym/storm-project/issues"
|
|
30
|
+
},
|
|
22
31
|
"files": [
|
|
23
32
|
"dist",
|
|
24
33
|
"svg",
|
|
25
|
-
"README.md"
|
|
34
|
+
"README.md",
|
|
35
|
+
"LICENSE"
|
|
26
36
|
],
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "node build.js && tsup",
|
|
39
|
+
"dev": "tsup --watch",
|
|
40
|
+
"lint": "eslint src",
|
|
41
|
+
"clean": "rm -rf dist src/*.tsx node_modules"
|
|
42
|
+
},
|
|
27
43
|
"keywords": [
|
|
28
44
|
"react",
|
|
29
45
|
"icons",
|
|
@@ -41,11 +57,5 @@
|
|
|
41
57
|
"svgo": "^4.0.0",
|
|
42
58
|
"tsup": "^8.0.1",
|
|
43
59
|
"typescript": "^5.3.3"
|
|
44
|
-
},
|
|
45
|
-
"scripts": {
|
|
46
|
-
"build": "node build.js && tsup",
|
|
47
|
-
"dev": "tsup --watch",
|
|
48
|
-
"lint": "eslint src",
|
|
49
|
-
"clean": "rm -rf dist src/*.tsx node_modules"
|
|
50
60
|
}
|
|
51
|
-
}
|
|
61
|
+
}
|