Skip to content

README.md

Latest commit

 

History

History
124 lines (87 loc) · 4.2 KB

README.md

File metadata and controls

124 lines (87 loc) · 4.2 KB
Raw

ProXIcons

GitHub stars GitHub forks GitHub license GitHub issues GitHub pull requests GitHub last commit GitHub repo size GitHub code size in bytes GitHub language count Top language Maintenance

High Quality, Modern, and Lightweight Open Source Icons

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.

What's New

v1.4.3

  • Version conflict resolved and metadata updated
  • Improved build system and development scripts
  • Optimized SVG handling using svgo
  • Minor internal fixes for better stability

v1.3.0

  • Initial release with 1500+ unique icons
  • Supports regular, solid, and brand variants
  • Includes Web Component for seamless integration

Installation

To install via npm:

npm install proxicons --save

Import the module:

import 'proxicons';

Usage

Using via CSS

  1. Include the stylesheet in your HTML <head>:
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/proxicons@latest/css/proxicons.min.css">
  1. Use the icons with classes px, pxs, and pxl:
<i class="px px-lightbulb"></i>
<i class="pxs px-lightbulb"></i>
<i class="pxl px-github"></i>

Using via Web Component

<script src="https://cdn.jsdelivr.net/npm/proxicons@latest/dist/proxicons.js"></script>

Example usage:

<prox-icon name="lightbulb"></prox-icon>
<prox-icon type="solid" name="lightbulb"></prox-icon>
<prox-icon type="logo" name="github"></prox-icon>

Attributes

<prox-icon
    type="regular|solid|logo"
    name="icon-name"
    color="blue|red|..."
    size="xs|sm|md|lg|40px"
    rotate="90|180|270"
    flip="horizontal|vertical"
    border="square|circle"
    animation="spin|tada|..."
    pull="left|right"
></prox-icon>

🚀 ProXIcons Icon Preview

Here’s a quick look at some beautiful, pixel-perfect icons from ProXIcons

Visit the Full Icon Gallery to explore all available icons.

Contributing & Contributors

We welcome contributions of all kinds — from fixing bugs and adding icons to improving docs and star-gazing!

Thanks to all our amazing contributors for helping make ProXIcons better!

Your name could be here — contribute today!

License

View Full License