Icons Monorepo

A lightweight icon library delivering Font Awesome's high-quality icons via a framework-agnostic Web Component, with perfect, icon-level tree-shaking.

✨ Features

• 🌳 Perfect Tree-shaking: The architecture ensures that unused icons are always eliminated from your production build.
• 🧩 Framework Agnostic: Built with a native Web Component. Works in React, Svelte, Vue, Astro, or simple HTML without wrappers.
• 👥 Extensible by the community: Propose new icons to create the most complete icon library with high quality.
• 🎨 Intuitive Styling: Style icons directly with your favorite utility classes. No new APIs to learn.
• 🚀 Simple API: No complex configuration. Import your icon's SVG and pass it to the component.

---

🚀 Performance Snapshot

@ev-forge/icons is designed for performance. In a benchmark simulating a modern application (a Vite + React SPA loading 32 unique icons), @ev-forge/icons demonstrates a significantly smaller impact on the final bundle.

Benchmark Results:

Library	Bundle Impact (gzip)
@fortawesome libs in react	~144 KB
@ev-forge/icons	~34 KB

For a detailed analysis and to reproduce these results, please see the benchmark package's README.

🏁 Get Started (vite/react)

• install: npm i @ev-forge/icons
• set up the types in your tsconfig: include: ["node_modules/@ev-forge/icons/dist/global.d.ts"]
• import and use it:

// 1. import icons
import { solidHouse, solidRadio } from "@ev-forge/icons";

// 2. use them in ev-icon
function MyApp() {
  return (
    <div>
      <ev-icon svg={solidHouse} class="w-6 text-blue-500" />
      <ev-icon svg={solidRadio} />
    </div>
  );
}

For a deep dive into the API, advanced features, and step-by-step integration guides for popular frameworks like Next.js and Astro, please see the full package documentation.

➡️ Full ev-icon Documentation

monorepo-info-begin

This monorepo contains the following packages, managed with pnpm workspaces:

Package	Description
📦 packages/icons	The core icon library, published to npm.
🌐 apps/docs	The official landing page and browser icons site.
📊 apps/benchmark-vite-react	The performance benchmark app for Vite + React.

To get started with local development, clone the repository and run pnpm install.

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide to get started.

🗺️ Roadmap

We have a clear vision for @ev-forge/icons. Our future plans include:

• A streamlined process for community-submitted original icons.
• Continued performance optimizations for render-time.
• Enhanced Accessibility: Audit and improve ARIA roles and keyboard interactions.
• Research and implement full SSR support

📄 License

The source code for this project is released under the MIT License.

The base icons are provided by Font Awesome Free and are licensed under CC BY 4.0.