Increase icon flexibility

[keatz55]

Color mode icons don't render unless using paid FontAwesome plan. Also, the phoenix famework has since changed how it implements heroicons. As a result, this PR makes the following updates:

• Adds new local_icon component for custom localized icons
  • allows for latest phoenix framework hero icon implementation
  • makes icons future proof by allowing users to use local implementations
• adds support for color_mode_icons config override
  • defaults to current fa icons
  • allows users to swap out color mode icons w/ local and/or hero provider icons

[keatz55]

I have to step out, but will ensure works as expected for sidebar/page-header icons a bit later.

[cblavier]

All looks great, thanks! ❤️
I will review it this Monday

[cblavier]

Thanks for your awesome work 🙏

I added some comments and noticed a few other quirks:

• validation_helpers.ex raises when declaring a local icon in a story
• we need to relax heroicons dependency to allow users to pick the heroicons elixir package or the TailwindCSS one
• when declaring a local icon with {:local, "hero-check-badge", :micro} Tailwind JIT won't pick the hero-check-badge-micro variant. This is working with {:local, "hero-check-badge-micro"}. Should we drop the style option for local_icons?

Do you want to continue, or do you prefer I take over?

[keatz55]

Thanks for your awesome work 🙏

I added some comments and noticed a few other quirks:

• validation_helpers.ex raises when declaring a local icon in a story
• we need to relax heroicons dependency to allow users to pick the heroicons elixir package or the TailwindCSS one
• when declaring a local icon with {:local, "hero-check-badge", :micro} Tailwind JIT won't pick the hero-check-badge-micro variant. This is working with {:local, "hero-check-badge-micro"}. Should we drop the style option for local_icons?

Do you want to continue, or do you prefer I take over?

@cblavier I'm flexible. It's your lib so I understand if you have a desired path forward for relaxing heroicons, etc. I'll defer to you, but I can cut the requested changes later today if desired.

[cblavier]

Thank you!
You can proceed with the changes, and I'll do a final round of polishing before we ship 🚀

[keatz55]

@cblavier Just pushed the following requested changes:

• fix validation_helpers.ex errors
• remove :local icon style attr to prevent false sense of security around tw jit comp
• doc example improvement/fixes
• fix color mode icon fa_plan={@fa_plan} attr in header
• phoenix_storybooke.ex Macro.escape(opts) simplification

Let me know if I missed anything

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.90%. Comparing base (417c7cb) to head (50b74c6).
Report is 16 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #518      +/-   ##
==========================================
- Coverage   95.91%   95.90%   -0.01%     
==========================================
  Files          38       38              
  Lines        2054     2052       -2     
==========================================
- Hits         1970     1968       -2     
  Misses         84       84              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[cblavier]

🎉 🔥 ❤️