Class: Fluxbit::BadgeComponent

Inherits:
Component
  • Object
show all
Includes:
Config::BadgeComponent
Defined in:
app/components/fluxbit/badge_component.rb

Overview

The ‘Fluxbit::BadgeComponent` is a customizable badge component that extends `Fluxbit::Component`. It allows you to create badges with different colors, sizes, borders, and shapes (pill).

Constant Summary

Constants inherited from Component

Component::ComponentObj

Instance Method Summary collapse

Methods inherited from Component

#add, #add_popover_or_tooltip, #anyicon, #element_name, #fx_id, #icon, #options, #popover?, #random_id, #remove_class, #remove_class_from_props, #render_popover_or_tooltip, #target, #tooltip?

Methods included from IconHelpers

#chevron_double_left, #chevron_double_right, #chevron_down, #chevron_left, #chevron_right, #chevron_up, #close_icon, #ellipsis_horizontal, #eye_icon, #eye_slash_icon, #plus_icon

Constructor Details

#initialize(**props) ⇒ Fluxbit::BadgeComponent

Initializes the badge component with the given properties.

Parameters:

  • props (Hash) —

    The properties to customize the badge.

Options Hash (**props):

  • :color (Symbol, String) —

    The color style of the badge.

  • :pill (Boolean) — default: false —

    Determines if the badge is pill-shaped.

  • :size (Symbol, Integer) —

    The size of the badge (e.g., ‘0` to `1`).

  • :perfect_rounded (Symbol, String) — default: :none —

    Define if the bage is a perfect rounded with size (e.g., ‘0` to `5`).

  • :as (Symbol, String) —

    The HTML tag to use for the badge (e.g., ‘:span`, `:div`).

  • :remove_class (String) — default: '' —

    Classes to remove from the default class list.

  • :popover_text (String) — default: nil —

    Popover text (from Fluxbit::Component).

  • :popover_placement (Symbol) — default: :right —

    Popover placement (e.g., ‘:right`, `:left`, `:top`, `:bottom`) (from Fluxbit::Component).

  • :popover_trigger (Symbol) — default: :hover —

    Popover trigger (e.g., ‘:hover`, `:click`) (from Fluxbit::Component).

  • :tooltip_text (String) — default: nil —

    Tooltip text (from Fluxbit::Component).

  • :tooltip_placement (Symbol) — default: :right —

    Tooltip placement (e.g., ‘:right`, `:left`, `:top`, `:bottom`) (from Fluxbit::Component).

  • :tooltip_trigger (Symbol) — default: :hover —

    Tooltip trigger (e.g., ‘:hover`, `:click`) (from Fluxbit::Component).

  • **props (Hash) —

    Remaining options declared as HTML attributes.



36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'app/components/fluxbit/badge_component.rb', line 36

def initialize(**props)
  super
  @props = props
  @color = options @props.delete(:color), collection: styles[:colors].keys, default: @@color
  @pill = options @props.delete(:pill), default: @@pill
  @size = options @props.delete(:size), default: @@size
  @perfect_rounded = options @props.delete(:perfect_rounded), default: @@perfect_rounded
  @notification = options @props.delete(:notification), default: @@notification
  @as = options @props.delete(:as), default: @@as

  add(class: badge_classes, to: @props, first_element: true)
  @props[:class] = remove_class(@props.delete(:remove_class) || "", @props[:class])
end

Instance Method Details

#before_render ⇒ Object 



50
51
52
 
# File 'app/components/fluxbit/badge_component.rb', line 50

def before_render
  add_popover_or_tooltip
end

#call ⇒ Object 



54
55
56
 
# File 'app/components/fluxbit/badge_component.rb', line 54

def call
  concat(content_tag(@as, content, @props) + render_popover_or_tooltip.to_s)
end