proicons 4.8.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 +64 -0
- package/dist/icons.json +430 -0
- package/dist/proicons.js +2 -0
- package/dist/proicons.js.map +1 -0
- package/dist/tags.json +1713 -0
- package/lib/categories.d.ts +2 -0
- package/lib/getIconInfo.d.ts +3 -0
- package/lib/interfaces.d.ts +20 -0
- package/lib/proicons.d.ts +440 -0
- package/lib/replace.d.ts +3 -0
- package/lib/search.d.ts +3 -0
- package/package.json +41 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 ProCode
|
|
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,64 @@
|
|
|
1
|
+
# ProIcons
|
|
2
|
+
<img src="./.github/images/cover.png">
|
|
3
|
+
|
|
4
|
+
[](https://github.com/ProCode-Software/proicons/releases)
|
|
5
|
+
[]()
|
|
6
|
+
[](https://www.npmjs.com/package/proicons)
|
|
7
|
+
|
|
8
|
+
<p align="center"><b>A collection of 400+ modern and open-source icons and logos</b></p>
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
### Node.js
|
|
12
|
+
1. Install the ProIcons package via [NPM](https://https://www.npmjs.com/package/proicons):
|
|
13
|
+
```console
|
|
14
|
+
npm install proicons
|
|
15
|
+
```
|
|
16
|
+
2. Use ProIcons inside JavaScript
|
|
17
|
+
```javascript
|
|
18
|
+
import proicons from 'proicons'
|
|
19
|
+
|
|
20
|
+
// Refer to the icon
|
|
21
|
+
proicons.icons.add
|
|
22
|
+
```
|
|
23
|
+
_or_
|
|
24
|
+
|
|
25
|
+
```html
|
|
26
|
+
<!-- Insert the icon -->
|
|
27
|
+
<i proicon="add"></i>
|
|
28
|
+
|
|
29
|
+
<script src="path/to/proicons/dist/proicons.js"></script>
|
|
30
|
+
|
|
31
|
+
<!-- Replace icons with SVG -->
|
|
32
|
+
<script>proicons.replace()</script>
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### HTML
|
|
36
|
+
If you are not inside a Node environment, you can import the ProIcons script via a CDN provider
|
|
37
|
+
|
|
38
|
+
```html
|
|
39
|
+
<!-- Insert the icon -->
|
|
40
|
+
<i proicon="add"></i>
|
|
41
|
+
|
|
42
|
+
<script src="https://unpkg.com/proicons"></script>
|
|
43
|
+
|
|
44
|
+
<!-- Replace icons with SVG -->
|
|
45
|
+
<script>proicons.replace()</script>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Roadmap
|
|
49
|
+
- [x] NPM package
|
|
50
|
+
- [ ] Write documentation and guidelines
|
|
51
|
+
- [ ] PNG source code
|
|
52
|
+
- [ ] Figma plugin
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
ProIcons is MIT-licensed, giving you peace of mind using these icons in your project. Learn more [here](./LICENSE)
|
|
57
|
+
|
|
58
|
+
> [!WARNING]
|
|
59
|
+
> I do not own any of the logos used in the icon pack nor am I affiliated with their companies. Please use these logos under their respective company's terms and guidelines.
|
|
60
|
+
|
|
61
|
+
## Credits
|
|
62
|
+
- Icon design and guidelines inspired by Microsoft's [Fluent System Icons](https://github.com/microsoft/fluentui-system-icons)
|
|
63
|
+
- Alpha bleeding script from https://github.com/Corecii/Transparent-Pixel-Fix
|
|
64
|
+
- API based on [Feather Icons](https://github.com/feathericons/feather)
|