msr-icons 0.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/LICENSE +21 -0
- package/README.md +128 -0
- package/dist/index.cjs +219 -0
- package/dist/index.js +1413 -0
- package/dist/msr-icons.css +1 -0
- package/dist/vite.svg +1 -0
- package/package.json +62 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 MSR Icons
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# msr-icons
|
|
2
|
+
|
|
3
|
+
A lightweight, production-ready React SVG icon library with 100+ pre-built icons. Perfect for modern web applications.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- ✨ **100+ SVG Icons** – Social media, tech stack, UI, utilities, and custom icons
|
|
8
|
+
- 🎨 **Customizable** – Control color, size, and styling via props
|
|
9
|
+
- 📦 **Tree-shakeable** – Import only what you need
|
|
10
|
+
- ⚡ **Optimized** – Built with Vite for fast dev/build
|
|
11
|
+
- 🚀 **NPM Ready** – Published and ready to install
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install msr-icons
|
|
17
|
+
# or
|
|
18
|
+
yarn add msr-icons
|
|
19
|
+
# or
|
|
20
|
+
pnpm add msr-icons
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Quick Start
|
|
24
|
+
|
|
25
|
+
### Using the Icon Wrapper
|
|
26
|
+
|
|
27
|
+
```jsx
|
|
28
|
+
import { Icon } from 'msr-icons';
|
|
29
|
+
|
|
30
|
+
export default function App() {
|
|
31
|
+
return <Icon name="SvgFacebook" size={32} color="#286bc2" />;
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Importing Individual Icons
|
|
36
|
+
|
|
37
|
+
```jsx
|
|
38
|
+
import { SvgFacebook, SvgGithub, SvgTwitter } from 'msr-icons';
|
|
39
|
+
|
|
40
|
+
export default function App() {
|
|
41
|
+
return (
|
|
42
|
+
<div>
|
|
43
|
+
<SvgFacebook color="#286bc2" onClick={() => alert('Facebook')} />
|
|
44
|
+
<SvgGithub color="#000" />
|
|
45
|
+
<SvgTwitter color="#1DA1F2" isColored />
|
|
46
|
+
</div>
|
|
47
|
+
);
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Icon Props
|
|
52
|
+
|
|
53
|
+
### Common Props
|
|
54
|
+
|
|
55
|
+
- **`color`** (string) – SVG fill/stroke color. Default varies by icon.
|
|
56
|
+
- **`isColored`** (boolean) – Use brand color or custom color. Default: `true`
|
|
57
|
+
- **`onClick`** (function) – Click handler
|
|
58
|
+
- **`classes`** (string) – CSS class names
|
|
59
|
+
- **`className`** (string) – React className (for Icon wrapper)
|
|
60
|
+
- **`style`** (object) – Inline styles
|
|
61
|
+
|
|
62
|
+
### Icon-Specific Props
|
|
63
|
+
|
|
64
|
+
- **`SvgWIFI`** – `isDot` (boolean), `is4` (boolean)
|
|
65
|
+
- **`SvgSnapchat`** – `backgroundColor` (string)
|
|
66
|
+
- **`SvgLogin/SvgLogout`** – `lineWidth` (string)
|
|
67
|
+
- **`SvgInstagram`** – `onHover` (function)
|
|
68
|
+
|
|
69
|
+
## Available Icons
|
|
70
|
+
|
|
71
|
+
**Social Media:** Facebook, Twitter, Instagram, LinkedIn, GitHub, TikTok, Snapchat, WhatsApp, Telegram, Discord, Reddit, Pinterest, Viber, Vine
|
|
72
|
+
|
|
73
|
+
**Tech Stack:** JavaScript, React, NodeJS, Python, Java, PHP, Docker, AWS, Azure, Google Cloud
|
|
74
|
+
|
|
75
|
+
**UI Components:** Settings, Search, Menu, Trash, Edit, Download, Upload, Refresh, Reload, Send, Bell, Search, and more
|
|
76
|
+
|
|
77
|
+
**Utilities:** Mail, Phone, Map, Location, Printer, Shield, Globe, Internet, Disk
|
|
78
|
+
|
|
79
|
+
... and **100+ more icons**!
|
|
80
|
+
|
|
81
|
+
## Development
|
|
82
|
+
|
|
83
|
+
### Build
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
npm run build
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
### Dev Server
|
|
90
|
+
|
|
91
|
+
```bash
|
|
92
|
+
npm run dev
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Lint
|
|
96
|
+
|
|
97
|
+
```bash
|
|
98
|
+
npm lint
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## Project Structure
|
|
102
|
+
|
|
103
|
+
```
|
|
104
|
+
src/
|
|
105
|
+
├── SvgComponents.js # All icon exports
|
|
106
|
+
├── Icon.jsx # Icon wrapper component
|
|
107
|
+
├── Icon.css # Icon styling
|
|
108
|
+
├── index.js # Main entry point
|
|
109
|
+
└── App.jsx # Demo app
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## Publishing to NPM
|
|
113
|
+
|
|
114
|
+
This package is configured for NPM publishing:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
npm publish --access public
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Ensure `dist/` is built before publishing:
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
npm run build && npm publish
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## License
|
|
127
|
+
|
|
128
|
+
MIT
|