Class: Coco::Icon

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

Constant Summary

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_icon_sprite, #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.



14
15
16
 
# File 'app/components/coco/images/icon/icon.rb', line 14

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

Instance Method Details

#custom? ⇒ Boolean

Returns:

  • (Boolean) 


36
 
# File 'app/components/coco/images/icon/icon.rb', line 36

def custom? = IconSet.custom_icon?(name)

#name ⇒ Object 



30
31
32
 
# File 'app/components/coco/images/icon/icon.rb', line 30

def name
  IconSet.resolve_icon_name(@icon_name) if @icon_name.present?
end

#name? ⇒ Boolean

Returns:

  • (Boolean) 


34
 
# File 'app/components/coco/images/icon/icon.rb', line 34

def name? = name.present?

#svg ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'app/components/coco/images/icon/icon.rb', line 18

def svg
  if custom?
    IconSet.icon_svg(name)
  elsif name? && content.blank?
    %(<svg><use href="##{symbol_id}"></use></svg>).html_safe
  elsif content.present?
    content.to_s
  elsif Rails.env.development?
    raise "Missing icon '#{@icon_name}'"
  end
end