Class: Primer::OcticonSymbolsComponent

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/octicon_symbols_component.rb

Overview

OcticonSymbols renders a symbol dictionary using a list of <%= link_to_octicons %>.

Constant Summary

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Class Method Summary collapse

Instance Method Summary collapse

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(icons: []) ⇒ OcticonSymbolsComponent

Returns a new instance of OcticonSymbolsComponent.

Examples:

Symbol dictionary

<%= render(Primer::OcticonComponent.new(icon: :check, use_symbol: true, color: :success)) %>
<%= render(Primer::OcticonComponent.new(icon: :check, use_symbol: true, color: :danger)) %>
<%= render(Primer::OcticonComponent.new(icon: :check, use_symbol: true, size: :medium)) %>
<%= render(Primer::OcticonSymbolsComponent.new(icons: [{ symbol: :check }, { symbol: :check, size: :medium }])) %>

Parameters:

  • icons (Array<Hash>) (defaults to: []) —

    List of icons to render, in the format { symbol: :icon_name, size: :small }



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'app/components/primer/octicon_symbols_component.rb', line 15

def initialize(icons: [])
  @icons = {}
  icons.each do |icon|
    symbol = icon[:symbol]
    size = Primer::OcticonComponent::SIZE_MAPPINGS[
      fetch_or_fallback(Primer::OcticonComponent::SIZE_OPTIONS, icon[:size] || Primer::OcticonComponent::SIZE_DEFAULT, Primer::OcticonComponent::SIZE_DEFAULT)
    ]

    cache_key = Primer::Octicon::Cache.get_key(symbol: symbol, size: size)

    if (cache_icon = Primer::Octicon::Cache.read(cache_key))
      icon_instance = cache_icon
    else
      icon_instance = Octicons::Octicon.new(symbol, height: size)

      Primer::Octicon::Cache.set(cache_key, icon_instance)
    end

    # Don't put the same icon twice
    @icons[[symbol, icon_instance.height]] = icon_instance if @icons[[symbol, icon_instance.height]].nil?
  end
end

Class Method Details

._after_compile ⇒ Object 



42
43
44
 
# File 'app/components/primer/octicon_symbols_component.rb', line 42

def self._after_compile
  Primer::Octicon::Cache.preload!
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
 
# File 'app/components/primer/octicon_symbols_component.rb', line 38

def render?
  @icons.any?
end

#symbol_tags ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/components/primer/octicon_symbols_component.rb', line 46

def symbol_tags
  safe_join(
    @icons.values.map do |icon|
      content_tag(
        :symbol,
        icon.path.html_safe, # rubocop:disable Rails/OutputSafety
        id: "octicon_#{icon.symbol}_#{icon.height}",
        viewBox: icon.options[:viewBox],
        width: icon.width,
        height: icon.height
      )
    end
  )
end