Phlex::Icons gem

[AliOsm]

Hello everyone,

I've been migrating one of my projects to Phlex/PhlexUI over the past two weeks and realized I frequently use SVG icons from various sources like Heroicons, Bootstrap icons, and Flag icons. Instead of manually integrating these icons into a Shared::Icon component, I thought, why not build a gem that offers easy-to-use Phlex components for these popular icon packs?

Initially, I came across the phlex-heroicons gem, which provides Phlex components for Heroicons. It was exactly what I needed but only for Heroicons.

So, I decided to create the phlex-icons gem. This gem generates Phlex components for icons from multiple sources automatically using the phlexing gem. Currently, phlex-icons includes over 4,000 icons from four different sources:

1. Heroicons (300+)
2. Lucide icons (1,500+)
3. Bootstrap icons (2,000+)
4. Flag icons (250+)

The goal of phlex-icons is to provide developers with a centralized, easy-to-integrate solution for incorporating a wide range of icons into their Phlex/PhlexUI projects. By automating the generation of icon components, this gem can save a significant amount of time and effort.

As a next step, I'm planning to set up a GitHub Actions workflow to automatically update the icon packs weekly, ensuring that users always have access to the latest icons.

I'd love to hear your thoughts on this project! Are there other icon packs you’d like to see included? Any features or improvements you think would be valuable? Please feel free to try out the gem, share your feedback, and contribute to its development.

Thank you!

[cirdes]

@AliOsm, congratulations on the gem! It is really useful for working with icons in the Rails universe. For PhlexUI/RbUI, it's better to work directly with the SVGs to avoid additional dependencies and keep things simple.

For the website, we're using the lucide-rails gem, which I'm helping to maintain.

https://github.com/PhlexUI/PhlexUI-web/blob/18546222ec35b62ae53211d43c16344ad520b894/Gemfile#L25

[AliOsm]

I noticed the use of lucide icons gem in the webapp, that is why I added them to phlex-icons, as I didn't know about them before, they are really beautiful.

In general, do you think the phlex-icons idea is a good one? I mean, having 4,000+ classes 😁

[cirdes]

@AliOsm , PhlexUI is inspired by shadcn and shadcn uses Lucide! 😄

I do think it's a great idea and more important, Joel seems to agree with you!

https://github.com/orgs/phlex-ruby/discussions/756#discussioncomment-10507043

[AliOsm]

Oh I didn't realize that Joel replied :3
Let's see what will happen :) Thanks for the support!

[AliOsm]

I just noticed the existence of phlex-lucide, if PhlexUI-Web is interested :3

[AliOsm]

If you don't like the all in one solution for any reason, phlex-icons is now available as a separate gem per icon pack, you just need to append -{icon pack name} to the gem name and you will get it (e.g. phlex-icons-lucide) 🎉