Make CustomIconBuilder work for SVG icon sets on Propshaft - #211
Merged
Merged
Conversation
`bin/rails g rolemodel:optics:icons --hugeicons` renders icons as inline SVG read from files the app vendors, instead of an icon font. - SvgIconBuilder: reads app/icons/<name>.svg once per process (re-reads while code reloading is on). Decorative by default (aria-hidden); hover_text: makes the span role="img" with an aria-label. - HugeiconsIconBuilder: app/icons/hugeicons/<style>/<name>.svg; filled: and duotone: map to solid-rounded and duotone-rounded, style: picks any style. - Rolemodel::Optics::Hugeicons: fetches SVGs from the Hugeicons API, rewrites colors to currentColor, and finds the icons views use. - Generator adds lib/tasks/optics_icons.rake (optics:icons:vendor) and spec/icons_spec.rb, which fails when a used icon is not vendored. Files live outside app/assets because Propshaft would serve them as downloads, which the Hugeicons Pro license does not allow. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
dallasbpeters
marked this pull request as ready for review
September 30, 2026 13:22
In a new app, bin/rails optics:icons:vendor failed with uninitialized constant Rolemodel::Optics, because only the icon helper required it. The task now requires it, and a bad icon name aborts with its message instead of a stack trace. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Jeremy-Walton
requested changes
Sep 30, 2026
| # downloadable file, which licensed sets (Hugeicons Pro) do not allow. | ||
| # | ||
| # Subclasses change where the files live (see HugeiconsIconBuilder). | ||
| class Rolemodel::Optics::SvgIconBuilder < Rolemodel::Optics::IconBuilder |
Member
There was a problem hiding this comment.
Pretty sure the existing custom icon builder already supports loading SVGs. This feels way more complicated than it needs to be.
Member
Author
There was a problem hiding this comment.
You're right. I removed the new builders, the API client, the rake task and the spec template. What's left is making CustomIconBuilder work for SVG sets: it now finds files on Propshaft as well as Sprockets (it called assets_manifest, which only Sprockets has), drops an undefined options reference that raised whenever the SVG was found, and emits Optics' svg-icon so the weight and emphasis modifiers apply. Styles are just subfolders: icon('duotone-rounded/home-01').
Review pointed out CustomIconBuilder already inlines SVGs, so the new SvgIconBuilder, HugeiconsIconBuilder, API client, rake task and spec template are gone. What CustomIconBuilder still needed: - Find the file with Propshaft as well as Sprockets. It called assets_manifest, which only Sprockets defines, so it raised on Propshaft. - Drop the reference to an undefined `options`, which raised whenever the SVG was found. - Emit Optics' `svg-icon` block so size, weight and emphasis modifiers apply to the SVG. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
dallasbpeters
changed the title
Jeremy-Walton
approved these changes
Sep 30, 2026
| ## SVG icons (for example, Hugeicons) | ||
|
|
||
| Use `--custom`. Put each SVG in `app/assets/images/icons/`, and `icon('name')` inlines it with | ||
| Optics' `.svg-icon` styles (Optics 2.5+), so size, weight and emphasis modifiers apply. A subfolder |
Member
There was a problem hiding this comment.
Will need to adjust with the .icon .icon--svg naming
15 of 22 tasks
Optics settled on a modifier nested inside .icon (RoleModel/optics#359). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Jeremy-Walton
approved these changes
Sep 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
SVG icon sets such as Hugeicons can't use a font builder. Review pointed out that
CustomIconBuilderalready inlines SVGs, so this PR now just makes it work for them.What changed
CustomIconBuilder:Rails.application.assets_manifest, which only Sprockets defines, so it raised on Propshaft (the gem's own example app uses Propshaft).options, which raised whenever the SVG was found.icon--svgmodifier instead ofcustom-icons, so size, weight and emphasis modifiers apply to the SVG. Needs Add .icon--svg for inline SVG icon sets optics#359.A subfolder works as part of the name, so a set with styles needs nothing extra:
icon('duotone-rounded/home-01')readsapp/assets/images/icons/duotone-rounded/home-01.svg.README: a short "SVG icons" section. New spec covers Propshaft, Sprockets and a missing file.
Removed from the first version
SvgIconBuilder,HugeiconsIconBuilder, the Hugeicons API client, theoptics:icons:vendorrake task and the vendored-icons spec template.Testing
bundle exec rspec: 108 examples, 0 failures.🤖 Generated with Claude Code