|
| 1 | +# ProXIcons |
| 2 | +[](https://github.com/ProgrammerKR/ProXIcons/issues) |
| 3 | +[](https://twitter.com/intent/tweet?text=Check%20out%20ProXIcons:&url=https%3A%2F%2Fgithub.com%2FProgrammerKR%2FProXIcons) |
| 4 | +[](https://paypal.me/ProgrammerKR) |
| 5 | + |
| 6 | +_High Quality, Modern, and Lightweight Open Source Icons_ |
| 7 | + |
| 8 | +**ProXIcons** is a clean, developer-friendly iconset crafted for modern web, app, and design projects. With over 1500+ icons and a focus on performance, ProXIcons is your go-to icon library for any creative need. |
| 9 | + |
| 10 | +## What's New in v1.0.0 |
| 11 | + |
| 12 | +- Initial release with 1500+ unique icons |
| 13 | +- Supports regular, solid, and brand variants |
| 14 | +- Includes Web Component for seamless integration |
| 15 | + |
| 16 | +## Installation |
| 17 | + |
| 18 | +To install via npm: |
| 19 | + |
| 20 | +```bash |
| 21 | +npm install proxicons --save |
| 22 | +``` |
| 23 | + |
| 24 | +Import the module: |
| 25 | + |
| 26 | +```javascript |
| 27 | +import 'proxicons'; |
| 28 | +``` |
| 29 | + |
| 30 | +## Usage |
| 31 | + |
| 32 | +### Using via CSS |
| 33 | + |
| 34 | +1. Include the stylesheet in your HTML `<head>`: |
| 35 | + |
| 36 | +```html |
| 37 | +<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/proxicons@latest/css/proxicons.min.css"> |
| 38 | +``` |
| 39 | + |
| 40 | +2. Use the icons with classes `px`, `pxs`, and `pxl`: |
| 41 | + |
| 42 | +```html |
| 43 | +<i class="px px-lightbulb"></i> |
| 44 | +<i class="pxs px-lightbulb"></i> |
| 45 | +<i class="pxl px-github"></i> |
| 46 | +``` |
| 47 | + |
| 48 | +### Using via Web Component |
| 49 | + |
| 50 | +```html |
| 51 | +<script src="https://cdn.jsdelivr.net/npm/proxicons@latest/dist/proxicons.js"></script> |
| 52 | +``` |
| 53 | + |
| 54 | +Example usage: |
| 55 | + |
| 56 | +```html |
| 57 | +<prox-icon name="lightbulb"></prox-icon> |
| 58 | +<prox-icon type="solid" name="lightbulb"></prox-icon> |
| 59 | +<prox-icon type="logo" name="github"></prox-icon> |
| 60 | +``` |
| 61 | + |
| 62 | +#### Attributes |
| 63 | + |
| 64 | +```html |
| 65 | +<prox-icon |
| 66 | + type="regular|solid|logo" |
| 67 | + name="icon-name" |
| 68 | + color="blue|red|..." |
| 69 | + size="xs|sm|md|lg|40px" |
| 70 | + rotate="90|180|270" |
| 71 | + flip="horizontal|vertical" |
| 72 | + border="square|circle" |
| 73 | + animation="spin|tada|..." |
| 74 | + pull="left|right" |
| 75 | +></prox-icon> |
| 76 | +``` |
| 77 | + |
| 78 | +## Contributors |
| 79 | + |
| 80 | +Thanks to all contributors who help maintain and improve this project! |
| 81 | + |
| 82 | +## License |
| 83 | + |
| 84 | +- Icons: CC 4.0 |
| 85 | +- Fonts: SIL OFL 1.1 |
| 86 | +- Other Files: MIT |
| 87 | + |
| 88 | +[Read the full license here](https://github.com/ProgrammerKR/ProXIcons/blob/main/LICENSE) |
| 89 | + |
| 90 | +## Contributing |
| 91 | + |
| 92 | +Pull requests and contributions are welcome! Caught an issue or have an idea? [Open an issue](https://github.com/ProgrammerKR/ProXIcons/issues) or [edit the README](https://github.com/ProgrammerKR/ProXIcons/edit/main/README.md) |
0 commit comments