phlex-icons-hero 2.18.0 → 2.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54fed0c753f9d5fb5f0e1f373f5768302c47d08913b2e4fb9b0a1d52f9751b63
-  data.tar.gz: e35dbaf015eb650e8b63702b4f2ab01a62ce9eb39c9ccb844395cf126c710833
+  metadata.gz: 516c3956d0aabe4a45d508bf9d741908c1b2b907892b53f310dce7263f330c39
+  data.tar.gz: 05a10bc366ee66f772fb68c24a6f12e7e395b70422f5257ae4952e69427830d4
 SHA512:
-  metadata.gz: 6af7acae316cb49f12d1648b663731665576504d90be677011e299b848efed8b7cf2e29796750eb9929de118301740b1132ca7cebe75b6e35247ec9455073a65
-  data.tar.gz: 68e51da4569e1e0a09300003c1eb8759d0d4a13d7da9f1ebf2c784f2042ee06b762e458d5612441958189c7201eb536e44c0957e96ee9c9422278d328c082506
+  metadata.gz: 790e77a859880ad2b7d82fe75ea0f5ac7e0d763fba377f32f550b6754b7029ae6d05caaf63837c6abb79f4cdd246bf7bd7f372434c87fe4726c72b9c6ab767fa
+  data.tar.gz: ac704b49da20197570a222f303ed18e88e9dd3cad1be618392688e2871a0b8875e1dd83dc053fd65a1a9140f78b97ce72937b41d9dccc84bf7560420dbb4d3b9

data/.rubocop.yml

@@ -25,4 +25,8 @@ Metrics/MethodLength:
   CountAsOne: ['array', 'method_call']
 
 Metrics/ClassLength:
-  CountAsOne: ['array', 'method_call']
+  CountAsOne: ['array', 'method_call']
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/README.md

@@ -62,11 +62,15 @@ The gem provides global configuration options, and per icons pack configuration
 ```ruby
 PhlexIcons.configure do |config|
   config.default_classes = 'size-6'
+  config.helper_method_name = :phlex_icon # Default: :phlex_icon
+  config.default_pack = :hero # Default: nil. Accepts :symbol, "string", or Class (e.g., PhlexIcons::Hero)
 end
 
 # OR
 
 PhlexIcons.configuration.default_classes = 'size-6'
+PhlexIcons.configuration.helper_method_name = :phlex_icon
+PhlexIcons.configuration.default_pack = :hero
 ```
 
 ### Bootstrap Icons configuration
@@ -153,6 +157,9 @@ class PhlexIcons < Phlex::HTML
       Radix::Home(class: 'size-4')
       Remix::HomeLine(class: 'size-4')
       Tabler::Home(variant: :filled, class: 'size-4')
+
+      # or with a string
+      Icon('bootstrap/house', class: 'size-4')
     end
   end
 end
@@ -174,11 +181,48 @@ class PhlexIcons < Phlex::HTML
       render PhlexIcons::Radix::Home.new(class: 'size-4')
       render PhlexIcons::Remix::HomeLine.new(class: 'size-4')
       render PhlexIcons::Tabler::Home.new(variant: :filled, class: 'size-4')
+
+      # or with a string
+      render PhlexIcons::Icon('bootstrap/house', class: 'size-4')
     end
   end
 end
 ```
 
+### Rails View Helper
+
+`phlex-icons` provides a convenient helper method to render icons directly in your ERB or Phlex views.
+
+By default, the helper method is named `phlex_icon`, but is configurable.
+
+```erb
+<%# Render a Bootstrap house icon with default size %>
+<%= phlex_icon 'bootstrap/house' %>
+
+<%# Render a Heroicons solid home icon with a specific class %>
+<%= phlex_icon 'hero/home', variant: :solid, class: 'w-5 h-5 text-blue-500' %>
+
+<%# Render a Tabler home icon, filled variant %>
+<%= phlex_icon 'tabler/home:filled' %>
+
+<%# If default_pack = :hero, render a Heroicons home icon %>
+<%= phlex_icon 'home', class: 'w-6 h-6' %>
+
+<%# Render a Flag icon (rectangle variant is default for flags if not configured otherwise) %>
+<%= phlex_icon 'flag/sa' %>
+
+<%# Render a custom icon %>
+<%= phlex_icon 'custom/my_awesome_icon:variant_name' %>
+```
+
+The first argument is the icon identifier. Such as: `'pack/icon_name:variant'`.
+
+*   If `default_pack` is configured, you can omit the pack name (e.g., `'icon_name:variant'` instead of `'pack/icon_name:variant'`).
+*   The `:variant` part is optional.
+*   Examples: `'hero/house:solid'`, `'house:solid'`, `'house'`
+
+Subsequent arguments are passed as options to the icon component, such as `variant`, `class`, etc.
+
 ### Specific icon pack(s)
 
 Let's say you want to use only Heroicons and Flag Icons, you can use the following gems:

data/generators/flag.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Flag
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/generators/hero.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Hero
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/generators/tabler.rb

@@ -36,7 +36,7 @@ VARIANT_TEMPLATE = ERB.new <<~VARIANT_TEMPLATE
     module Tabler
       class <%= icon_name %><%= variant.to_s.capitalize %> < Base
         def view_template
-          render <%= icon_name %>.new(variant: :<%= variant %>)
+          render <%= icon_name %>.new(variant: :<%= variant %>, **attrs)
         end
       end
     end

data/lib/phlex-icons/configuration.rb

@@ -2,10 +2,33 @@
 
 module PhlexIcons
   class Configuration
-    attr_accessor :default_variant, :default_classes
+    attr_accessor :default_variant, :default_classes, :helper_method_name
+    attr_reader :default_pack
 
     def initialize(default_classes: 'size-6')
       @default_classes = default_classes
+      @helper_method_name = :phlex_icon
+      @default_pack = nil
+    end
+
+    # Custom setter for default_pack
+    # Accepts Class (PhlexIcons::Hero), String ('hero'), or Symbol (:hero)
+    #
+    # @param value [Class, String, Symbol, nil] The value to set the default pack to.
+    # @raise [ArgumentError] If the value is not a Class, String, Symbol, or nil.
+    def default_pack=(value)
+      @default_pack = case value
+                      when Class
+                        # Extract 'Hero' from PhlexIcons::Hero, lowercase, symbolize
+                        value.name.split('::').last&.downcase&.to_sym
+                      when String, Symbol
+                        value.to_sym
+                      when nil
+                        nil
+                      else
+                        raise ArgumentError,
+                              "Invalid type for default_pack: #{value.class}. Expected Class, String, Symbol, or nil."
+                      end
     end
   end
 end

data/lib/phlex-icons/hero/academic_cap_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AcademicCapOutline < Base
       def view_template
-        render AcademicCap.new(variant: :outline)
+        render AcademicCap.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/academic_cap_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AcademicCapSolid < Base
       def view_template
-        render AcademicCap.new(variant: :solid)
+        render AcademicCap.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/adjustments_horizontal_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AdjustmentsHorizontalOutline < Base
       def view_template
-        render AdjustmentsHorizontal.new(variant: :outline)
+        render AdjustmentsHorizontal.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/adjustments_horizontal_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AdjustmentsHorizontalSolid < Base
       def view_template
-        render AdjustmentsHorizontal.new(variant: :solid)
+        render AdjustmentsHorizontal.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/adjustments_vertical_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AdjustmentsVerticalOutline < Base
       def view_template
-        render AdjustmentsVertical.new(variant: :outline)
+        render AdjustmentsVertical.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/adjustments_vertical_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class AdjustmentsVerticalSolid < Base
       def view_template
-        render AdjustmentsVertical.new(variant: :solid)
+        render AdjustmentsVertical.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_arrow_down_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxArrowDownOutline < Base
       def view_template
-        render ArchiveBoxArrowDown.new(variant: :outline)
+        render ArchiveBoxArrowDown.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_arrow_down_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxArrowDownSolid < Base
       def view_template
-        render ArchiveBoxArrowDown.new(variant: :solid)
+        render ArchiveBoxArrowDown.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxOutline < Base
       def view_template
-        render ArchiveBox.new(variant: :outline)
+        render ArchiveBox.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxSolid < Base
       def view_template
-        render ArchiveBox.new(variant: :solid)
+        render ArchiveBox.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_x_mark_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxXMarkOutline < Base
       def view_template
-        render ArchiveBoxXMark.new(variant: :outline)
+        render ArchiveBoxXMark.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/archive_box_x_mark_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArchiveBoxXMarkSolid < Base
       def view_template
-        render ArchiveBoxXMark.new(variant: :solid)
+        render ArchiveBoxXMark.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_circle_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownCircleOutline < Base
       def view_template
-        render ArrowDownCircle.new(variant: :outline)
+        render ArrowDownCircle.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_circle_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownCircleSolid < Base
       def view_template
-        render ArrowDownCircle.new(variant: :solid)
+        render ArrowDownCircle.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_left_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownLeftOutline < Base
       def view_template
-        render ArrowDownLeft.new(variant: :outline)
+        render ArrowDownLeft.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_left_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownLeftSolid < Base
       def view_template
-        render ArrowDownLeft.new(variant: :solid)
+        render ArrowDownLeft.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_on_square_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownOnSquareOutline < Base
       def view_template
-        render ArrowDownOnSquare.new(variant: :outline)
+        render ArrowDownOnSquare.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_on_square_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownOnSquareSolid < Base
       def view_template
-        render ArrowDownOnSquare.new(variant: :solid)
+        render ArrowDownOnSquare.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_on_square_stack_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownOnSquareStackOutline < Base
       def view_template
-        render ArrowDownOnSquareStack.new(variant: :outline)
+        render ArrowDownOnSquareStack.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_on_square_stack_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownOnSquareStackSolid < Base
       def view_template
-        render ArrowDownOnSquareStack.new(variant: :solid)
+        render ArrowDownOnSquareStack.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownOutline < Base
       def view_template
-        render ArrowDown.new(variant: :outline)
+        render ArrowDown.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_right_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownRightOutline < Base
       def view_template
-        render ArrowDownRight.new(variant: :outline)
+        render ArrowDownRight.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_right_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownRightSolid < Base
       def view_template
-        render ArrowDownRight.new(variant: :solid)
+        render ArrowDownRight.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownSolid < Base
       def view_template
-        render ArrowDown.new(variant: :solid)
+        render ArrowDown.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_tray_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownTrayOutline < Base
       def view_template
-        render ArrowDownTray.new(variant: :outline)
+        render ArrowDownTray.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_down_tray_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowDownTraySolid < Base
       def view_template
-        render ArrowDownTray.new(variant: :solid)
+        render ArrowDownTray.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_circle_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftCircleOutline < Base
       def view_template
-        render ArrowLeftCircle.new(variant: :outline)
+        render ArrowLeftCircle.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_circle_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftCircleSolid < Base
       def view_template
-        render ArrowLeftCircle.new(variant: :solid)
+        render ArrowLeftCircle.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_end_on_rectangle_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftEndOnRectangleOutline < Base
       def view_template
-        render ArrowLeftEndOnRectangle.new(variant: :outline)
+        render ArrowLeftEndOnRectangle.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_end_on_rectangle_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftEndOnRectangleSolid < Base
       def view_template
-        render ArrowLeftEndOnRectangle.new(variant: :solid)
+        render ArrowLeftEndOnRectangle.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_on_rectangle_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftOnRectangleOutline < Base
       def view_template
-        render ArrowLeftOnRectangle.new(variant: :outline)
+        render ArrowLeftOnRectangle.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_on_rectangle_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftOnRectangleSolid < Base
       def view_template
-        render ArrowLeftOnRectangle.new(variant: :solid)
+        render ArrowLeftOnRectangle.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftOutline < Base
       def view_template
-        render ArrowLeft.new(variant: :outline)
+        render ArrowLeft.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftSolid < Base
       def view_template
-        render ArrowLeft.new(variant: :solid)
+        render ArrowLeft.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_start_on_rectangle_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftStartOnRectangleOutline < Base
       def view_template
-        render ArrowLeftStartOnRectangle.new(variant: :outline)
+        render ArrowLeftStartOnRectangle.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_left_start_on_rectangle_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLeftStartOnRectangleSolid < Base
       def view_template
-        render ArrowLeftStartOnRectangle.new(variant: :solid)
+        render ArrowLeftStartOnRectangle.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_down_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongDownOutline < Base
       def view_template
-        render ArrowLongDown.new(variant: :outline)
+        render ArrowLongDown.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_down_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongDownSolid < Base
       def view_template
-        render ArrowLongDown.new(variant: :solid)
+        render ArrowLongDown.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_left_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongLeftOutline < Base
       def view_template
-        render ArrowLongLeft.new(variant: :outline)
+        render ArrowLongLeft.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_left_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongLeftSolid < Base
       def view_template
-        render ArrowLongLeft.new(variant: :solid)
+        render ArrowLongLeft.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_right_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongRightOutline < Base
       def view_template
-        render ArrowLongRight.new(variant: :outline)
+        render ArrowLongRight.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_right_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongRightSolid < Base
       def view_template
-        render ArrowLongRight.new(variant: :solid)
+        render ArrowLongRight.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_up_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongUpOutline < Base
       def view_template
-        render ArrowLongUp.new(variant: :outline)
+        render ArrowLongUp.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_long_up_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowLongUpSolid < Base
       def view_template
-        render ArrowLongUp.new(variant: :solid)
+        render ArrowLongUp.new(variant: :solid, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_path_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowPathOutline < Base
       def view_template
-        render ArrowPath.new(variant: :outline)
+        render ArrowPath.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_path_rounded_square_outline.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowPathRoundedSquareOutline < Base
       def view_template
-        render ArrowPathRoundedSquare.new(variant: :outline)
+        render ArrowPathRoundedSquare.new(variant: :outline, **attrs)
       end
     end
   end

data/lib/phlex-icons/hero/arrow_path_rounded_square_solid.rb

@@ -4,7 +4,7 @@ module PhlexIcons
   module Hero
     class ArrowPathRoundedSquareSolid < Base
       def view_template
-        render ArrowPathRoundedSquare.new(variant: :solid)
+        render ArrowPathRoundedSquare.new(variant: :solid, **attrs)
       end
     end
   end