PiruIcons

A premium, modern, and ultra-lightweight icon library for the web. PiruIcons features over 2,000 carefully crafted icons, including standard UI icons and special categories for global and Peruvian brands.

Features

• 2,000+ Icons: A vast collection for any UI need.
• Categorized: Standard UI icons, global Brands, and specialized Brands-Peru.
• Ultra-lightweight: Minified CSS and optimized web fonts.
• Developer Friendly: Support for CSS, SCSS, and raw SVG.
• High Performance: Pixel-perfect icons with optimized paths.

Installation

npm install piruicons
# or
pnpm add piruicons

Usage

1. Using CSS (Standard)

Include the minified CSS in your project:

<link rel="stylesheet" href="node_modules/piruicons/dist/css/piruicons.min.css">

2. Using SCSS

If you are using Sass/SCSS, you can import it directly:

@import "piruicons/scss";

3. Basic HTML Example

Use the .pi base class and the specific .pi-{icon-name} class:

<i class="pi pi-search"></i>
<i class="pi pi-heart-fill"></i>
<i class="pi pi-yape"></i>

Development

To customize or build the library from source:

1. Clone the repository.
2. Install dependencies: pnpm install.
3. Run the build script:

   pnpm build

   This will process the SVGs in /icons, optimize them, and generate the web fonts and styles in /dist.

Showcase

Check out the interactive showcase in the demo/ folder or visit the GitHub Pages deployment to search and preview all available icons.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Created with ❤️ by Pirulug