Class: SolidusAdmin::UI::Icon::Component

Inherits:
BaseComponent
  • Object
show all
Defined in:
app/components/solidus_admin/ui/icon/component.rb

Constant Summary collapse

NAMES =
Set.new(File.read("#{__dir__}/names.txt").split("\n").map(&:freeze)).freeze

Instance Method Summary collapse

Constructor Details

#initialize(name:, **attrs) ⇒ Component

Renders a remixincon svg.

Parameters:

  • name (String)

    the name of the icon

  • attrs (Hash)

    a customizable set of options

Options Hash (**attrs):

  • :class (String)

    the class to add to the svg

Raises:

  • (ArgumentError)

See Also:



11
12
13
14
15
16
17
18
19
20
21
22
23
# File 'app/components/solidus_admin/ui/icon/component.rb', line 11

def initialize(name:, **attrs)
  raise ArgumentError, "unkown icon #{name.inspect}" unless NAMES.include?(name.to_s)

  @name = name
  @attrs = attrs

  # Hide the icon from screen readers by default.
  @attrs['aria-hidden'] = true unless @attrs.key?('aria-hidden')

  # Default icons without style to 16x16, mostly useful in test snapshots.
  @attrs['width'] = '16'
  @attrs['height'] = '16'
end

Instance Method Details

#callObject



25
26
27
28
29
30
# File 'app/components/solidus_admin/ui/icon/component.rb', line 25

def call
  # bypass the asset_host configuration to avoid CORS issues with CDNs:
  # https://github.com/solidusio/solidus/issues/5657
  href = asset_path("solidus_admin/remixicon.symbol.svg#ri-#{@name}", host: "")
  tag.svg(tag.use("xlink:href": href), **@attrs)
end