Class: Coco::SystemBanner

Inherits:
Component
  • Object
show all
Includes:
Concerns::AcceptsOptions, Concerns::WrapsComponent
Defined in:
app/components/coco/messaging/system_banner/system_banner.rb

Constant Summary

Constants included from Concerns::AcceptsTagAttributes

Concerns::AcceptsTagAttributes::TAG_ATTRIBUTE_NAMES

Instance Attribute Summary collapse

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(id: nil, dismiss_for: nil) ⇒ SystemBanner

Returns a new instance of SystemBanner.



44
45
46
47
48
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 44

def initialize(id: nil, dismiss_for: nil, **)
  @id = id
  @dismiss_for = dismiss_for
  set_tag_attr(:id, id)
end

Instance Attribute Details

#dismiss_for ⇒ Object (readonly)

Returns the value of attribute dismiss_for.



42
43
44
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 42

def dismiss_for
  @dismiss_for
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



42
43
44
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 42

def id
  @id
end

Instance Method Details

#alpine_data ⇒ Object 



62
63
64
65
66
67
68
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 62

def alpine_data
  dismissable? ? {
    cookie_name: dismiss_cookie_name,
    cookie_expiry: dismiss_for&.in_days&.to_i,
    cookie_value: "true"
  } : {}
end

#dismiss_cookie_name ⇒ Object 



58
59
60
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 58

def dismiss_cookie_name
  :"cb_system_banner_#{tag_attr(:id)&.underscore}_dismissed"
end

#dismissable? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 50

def dismissable?
  get_option_value(:dismissable) == true
end

#render? ⇒ Boolean

Returns:

  • (Boolean) 


54
55
56
 
# File 'app/components/coco/messaging/system_banner/system_banner.rb', line 54

def render?
  helpers.cookies[dismiss_cookie_name] != "true"
end