Class: Coco::Icon

Inherits:
Component
  • Object
show all
Includes:
Concerns::AcceptsOptions
Defined in:
app/components/coco/images/icon/icon.rb

Constant Summary collapse

ICON_CACHE = 
{}
ALIASES = 
{
  edit: "pen-line",
  "edit-3": "pen-line",
  "git-commit": "git-commit-horizontal",
  grid: "grid-3x3",
  "user-circle": "circle-user",
  layout: "panels-top-left",
  "alert-circle": "circle-alert",
  "check-circle": "circle-check",
  "loader-2": "loader-circle",
  "alert-triangle": "triangle-alert",
  "arrow-right-circle": "circle-arrow-right",
  "check-square": "square-check",
  "help-circle": "circle-help",
  "plus-circle": "circle-plus",
  "plus-square": "square-plus",
  "bar-chart-2": "chart-no-axes-column",
  "bar-chart": "chart-no-axes-column-increasing",
  "more-horizontal": "ellipsis",
  "more-vertical": "ellipsis-vertical"
}.freeze
InvalidIconError = 
Class.new(StandardError)

Constants included from Concerns::AcceptsTagAttributes

Concerns::AcceptsTagAttributes::TAG_ATTRIBUTE_NAMES

Instance Method Summary collapse

Methods included from Concerns::AcceptsOptions

#accepted_options, #get_option_group

Methods inherited from Component

#accepts_options?, after_initialize, before_initialize, before_render, new

Methods included from AlpineHelper

#x_attrs, #x_data

Methods included from TagHelper

#prefix_attr_keys, #random_id, #style_str

Methods included from ComponentsHelper

#coco_avatar, #coco_badge, #coco_button, #coco_button_group, #coco_button_to, #coco_color_picker_button, #coco_component, #coco_confirm_button, #coco_dropdown, #coco_embed, #coco_fields, #coco_form_for, #coco_form_with, #coco_icon, #coco_image, #coco_image_picker_button, #coco_layout_picker_button, #coco_link, #coco_link_to, #coco_menu, #coco_menu_button, #coco_menu_item, #coco_modal, #coco_modal_canvas, #coco_modal_dialog, #coco_modal_lightbox, #coco_notice, #coco_option_bar, #coco_page, #coco_pager_button, #coco_panel, #coco_placeholder, #coco_popover, #coco_prose, #coco_seamless_textarea, #coco_snackbar, #coco_spacer, #coco_stack, #coco_stamp, #coco_svg, #coco_system_banner, #coco_tabs, #coco_tag, #coco_toast, #coco_toolbar, #coco_tooltip, #resolve_component

Methods included from Concerns::Translatable

#tt

Methods included from Concerns::HasName

#component_name

Methods included from Concerns::AcceptsTagAttributes

#tag_attrs

Constructor Details

#initialize(name: nil, **kwargs) ⇒ Icon

Returns a new instance of Icon.



42
43
44
 
# File 'app/components/coco/images/icon/icon.rb', line 42

def initialize(name: nil, **kwargs)
  @icon_name = name&.to_s&.tr("_", "-")
end

Instance Method Details

#custom? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'app/components/coco/images/icon/icon.rb', line 61

def custom?
  @_custom ||= File.exist?(custom_icon_path)
end

#custom_icon_path ⇒ Object 



79
80
81
 
# File 'app/components/coco/images/icon/icon.rb', line 79

def custom_icon_path
  @_custom_icon_path ||= Coco::Engine.root.join("app/assets/build/coco/icons/custom/#{name}.svg")
end

#icon_data ⇒ Object 



54
55
56
57
58
59
 
# File 'app/components/coco/images/icon/icon.rb', line 54

def icon_data
  ICON_CACHE[name] ||= {
    custom: custom?,
    svg: read_svg
  }
end

#icon_path ⇒ Object 



75
76
77
 
# File 'app/components/coco/images/icon/icon.rb', line 75

def icon_path
  @_icon_path ||= Coco::Engine.root.join("app/assets/build/coco/icons/#{name}.svg")
end

#name ⇒ Object 



46
47
48
 
# File 'app/components/coco/images/icon/icon.rb', line 46

def name
  ALIASES.fetch(@icon_name.to_sym, @icon_name) if @icon_name
end

#read_svg ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'app/components/coco/images/icon/icon.rb', line 65

def read_svg
  if custom?
    File.read(custom_icon_path).html_safe
  elsif File.exist?(icon_path)
    File.read(icon_path).html_safe
  elsif Rails.env.development? || Rails.env.test?
    raise InvalidIconError, "`#{name}` is not a valid icon name"
  end
end

#svg ⇒ Object 



50
51
52
 
# File 'app/components/coco/images/icon/icon.rb', line 50

def svg
  content || icon_data[:svg]
end