Class: Daisy::Layout::IndicatorComponent

Inherits:
LocoMotion::BaseComponent show all
Defined in:
app/components/daisy/layout/indicator_component.rb

Overview

The IndicatorComponent positions notification elements around its content to draw attention to important information. Common use cases include:

  • Notification badges on avatars.

  • Cart item counters.

  • “New” badges on features.

  • Status indicators on elements.

By default, indicators are positioned in the top-right corner, but they can be positioned anywhere around the content using CSS classes.

Constant Summary

Constants inherited from LocoMotion::BaseComponent

LocoMotion::BaseComponent::EMPTY_PART_IGNORED_TAGS, LocoMotion::BaseComponent::SELF_CLOSING_TAGS

Instance Attribute Summary

Attributes inherited from LocoMotion::BaseComponent

#config, #loco_parent

Instance Method Summary collapse

Methods inherited from LocoMotion::BaseComponent

build, #component_ref, #config_option, #cssify, define_modifier, define_modifiers, define_part, define_parts, define_size, define_sizes, #empty_part_content, #inspect, #part, register_component_initializer, register_component_setup, #rendered_css, #rendered_data, #rendered_html, #rendered_stimulus_controllers, #rendered_tag_name, renders_many, renders_one, set_component_name, #set_loco_parent, #strip_spaces

Constructor Details

#initialize(**kws) ⇒ IndicatorComponent

Creates a new Indicator component.

Parameters:

  • kws (Hash) —

    Keyword arguments for customizing the indicator.

Options Hash (**kws):

  • css (String) —

    Additional CSS classes for styling. Common options include:

    • Spacing: ‘p-2`, `m-4`

    • Alignment: ‘inline-flex`, `inline-grid`



60
61
62
 
# File 'app/components/daisy/layout/indicator_component.rb', line 60

def initialize(**kws)
  super
end

Instance Method Details

#before_render ⇒ Object

Sets up the component’s CSS classes.



67
68
69
 
# File 'app/components/daisy/layout/indicator_component.rb', line 67

def before_render
  add_css(:component, "indicator")
end

#call ⇒ Object

Renders the component, all indicator items, and the main content.



74
75
76
77
78
79
80
81
82
 
# File 'app/components/daisy/layout/indicator_component.rb', line 74

def call
  part(:component) do
    items.each do |item|
      concat(item)
    end

    concat(content) if content?
  end
end