How lab2023/heroicons-rails works
Heroicons::Rails is a small Rails view integration for rendering Heroicons SVGs. A view calls icon_tag; the helper applies configured defaults, searches application icons before bundled icons, and returns SVG markup. The gem also supports custom application icons and an install generator for creating a configuration initializer. The main rendering and configuration paths are supported by sampled source; icon-type and custom-icon capabilities are documented in the README.
Main entry points: application_helper.rb Icon helper · engine.rb Rails engine · install_generator.rb Install generator · configuration.rb Configuration
Components 8
Other components
- Rails view
- Rails engine
lib/heroicons/engine.rb - Icon helper
app/helpers/heroicons/application_helper.rb - Configuration
lib/heroicons/configuration.rb - Application icons
app/assets/images/icons - Bundled icons
app/assets/images/icons - Install generator
lib/generators/heroicons/install_generator.rb - Initializer template
lib/generators/heroicons/templates/initializer.rb
Connections 7
- Rails engine → Icon helper: includes on load
- Rails view → Icon helper: calls icon_tag
- Icon helper → Configuration: reads defaults
- Icon helper → Application icons: searches first
- Icon helper → Bundled icons: searches fallback
- Icon helper → Rails view: returns SVG
- Install generator → Initializer template: copies template