utruckin-icons 1.5.4 → 2.0.0
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 +1 -95
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -21,22 +21,10 @@ npm install utruckin-icons
|
|
|
21
21
|
</template>
|
|
22
22
|
|
|
23
23
|
<script setup>
|
|
24
|
-
import { Clock, Truck } from
|
|
24
|
+
import { Clock, Truck } from "utruckin-icons";
|
|
25
25
|
</script>
|
|
26
26
|
```
|
|
27
27
|
|
|
28
|
-
### Import All Icons
|
|
29
|
-
|
|
30
|
-
```vue
|
|
31
|
-
<script setup>
|
|
32
|
-
import * as Icons from 'utruckin-icons';
|
|
33
|
-
</script>
|
|
34
|
-
|
|
35
|
-
<template>
|
|
36
|
-
<Icons.Clock :size="24" />
|
|
37
|
-
</template>
|
|
38
|
-
```
|
|
39
|
-
|
|
40
28
|
## Props
|
|
41
29
|
|
|
42
30
|
All icon components accept the following props:
|
|
@@ -80,85 +68,3 @@ Icons use `currentColor` by default, so you can control color via CSS:
|
|
|
80
68
|
<Clock class="my-icon-class" />
|
|
81
69
|
```
|
|
82
70
|
|
|
83
|
-
## Development
|
|
84
|
-
|
|
85
|
-
### Project Structure
|
|
86
|
-
|
|
87
|
-
```
|
|
88
|
-
utruckin-icons/
|
|
89
|
-
├── src/
|
|
90
|
-
│ └── icons/ # Place your SVG files here
|
|
91
|
-
├── dist/ # Generated Vue components (auto-generated)
|
|
92
|
-
├── scripts/
|
|
93
|
-
│ └── build.js # Build script
|
|
94
|
-
├── package.json
|
|
95
|
-
└── README.md
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Adding New Icons
|
|
99
|
-
|
|
100
|
-
1. Add your SVG files to `src/icons/` directory
|
|
101
|
-
2. Name files in kebab-case (e.g., `arrow-left.svg`, `home-icon.svg`)
|
|
102
|
-
3. Run the build script:
|
|
103
|
-
|
|
104
|
-
```bash
|
|
105
|
-
npm run build
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
The build script will:
|
|
109
|
-
- Convert SVG files to Vue components
|
|
110
|
-
- Convert filenames to PascalCase (e.g., `arrow-left.svg` → `ArrowLeft.vue`)
|
|
111
|
-
- Replace fill colors with `currentColor` for theming
|
|
112
|
-
- Make width/height dynamic via the `size` prop
|
|
113
|
-
- Generate TypeScript definitions
|
|
114
|
-
|
|
115
|
-
### SVG Requirements
|
|
116
|
-
|
|
117
|
-
- Use valid SVG format
|
|
118
|
-
- Include `viewBox` attribute for proper scaling
|
|
119
|
-
- Use `fill="none"` or specific colors (will be replaced with `currentColor`)
|
|
120
|
-
|
|
121
|
-
### Build Commands
|
|
122
|
-
|
|
123
|
-
```bash
|
|
124
|
-
# Build all icons
|
|
125
|
-
npm run build
|
|
126
|
-
|
|
127
|
-
# Watch mode (future enhancement)
|
|
128
|
-
npm run dev
|
|
129
|
-
```
|
|
130
|
-
|
|
131
|
-
## Publishing
|
|
132
|
-
|
|
133
|
-
### First Time Setup
|
|
134
|
-
|
|
135
|
-
```bash
|
|
136
|
-
# Login to npm
|
|
137
|
-
npm login
|
|
138
|
-
|
|
139
|
-
# Publish
|
|
140
|
-
npm publish
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### Publishing Updates
|
|
144
|
-
|
|
145
|
-
```bash
|
|
146
|
-
# Update version
|
|
147
|
-
npm version patch # 1.0.0 → 1.0.1
|
|
148
|
-
npm version minor # 1.0.0 → 1.1.0
|
|
149
|
-
npm version major # 1.0.0 → 2.0.0
|
|
150
|
-
|
|
151
|
-
# Publish
|
|
152
|
-
npm publish
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
## License
|
|
156
|
-
|
|
157
|
-
MIT
|
|
158
|
-
|
|
159
|
-
## Contributing
|
|
160
|
-
|
|
161
|
-
1. Add your SVG files to `src/icons/`
|
|
162
|
-
2. Run `npm run build`
|
|
163
|
-
3. Test the generated components
|
|
164
|
-
4. Submit a pull request
|