Class: Fluxbit::SpinnerComponent

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

Overview

The ‘Fluxbit::SpinnerComponent` is a component for rendering loading spinners.

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::SpinnerComponent

Initializes the Spinner component with various customization options.

Parameters:

  • **props (Hash) —

    The properties to customize the spinner.

  • props (Hash) —

    a customizable set of options

Options Hash (**props):

  • :color (Symbol) — default: :default —

    The color theme of the spinner (:default, :info, :success, :failure, :warning, :pink, :purple).

  • :size (Integer) — default: 1 —

    The size of the spinner (0 to 4).

  • :label (String) — default: 'Loading...' —

    The aria-label for accessibility.

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

    CSS classes to remove from the default class list.

  • **props (Hash) —

    Remaining options declared as HTML attributes.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'app/components/fluxbit/spinner_component.rb', line 17

def initialize(**props)
  super
  @props = props

  @color = options @props.delete(:color), collection: styles[:colors].keys, default: @@color
  @size = options @props.delete(:size), collection: (0..styles[:sizes].size - 1).to_a, default: @@size
  @label = @props.delete(:label) || @@label

  add class: [
    styles[:base],
    styles[:sizes][@size.to_i],
    styles[:colors][@color]
  ], to: @props

  # Add accessibility attributes
  @props[:role] = "status"
  @props[:"aria-label"] = @label

  remove_class_from_props(@props)
end

Instance Method Details

#call ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'app/components/fluxbit/spinner_component.rb', line 38

def call
  tag.svg(**@props, viewBox: "0 0 100 101", fill: "none", xmlns: "http://www.w3.org/2000/svg") do
    concat(
      tag.path(
        d: "M100 50.5908C100 78.2051 77.6142 100.591 50 100.591C22.3858 100.591 0 78.2051 0 50.5908C0 22.9766 22.3858 0.59082 50 0.59082C77.6142 0.59082 100 22.9766 100 50.5908ZM9.08144 50.5908C9.08144 73.1895 27.4013 91.5094 50 91.5094C72.5987 91.5094 90.9186 73.1895 90.9186 50.5908C90.9186 27.9921 72.5987 9.67226 50 9.67226C27.4013 9.67226 9.08144 27.9921 9.08144 50.5908Z",
        fill: "currentColor"
      )
    )
    concat(
      tag.path(
        d: "M93.9676 39.0409C96.393 38.4038 97.8624 35.9116 97.0079 33.5539C95.2932 28.8227 92.871 24.3692 89.8167 20.348C85.8452 15.1192 80.8826 10.7238 75.2124 7.41289C69.5422 4.10194 63.2754 1.94025 56.7698 1.05124C51.7666 0.367541 46.6976 0.446843 41.7345 1.27873C39.2613 1.69328 37.813 4.19778 38.4501 6.62326C39.0873 9.04874 41.5694 10.4717 44.0505 10.1071C47.8511 9.54855 51.7191 9.52689 55.5402 10.0491C60.8642 10.7766 65.9928 12.5457 70.6331 15.2552C75.2735 17.9648 79.3347 21.5619 82.5849 25.841C84.9175 28.9121 86.7997 32.2913 88.1811 35.8758C89.083 38.2158 91.5421 39.6781 93.9676 39.0409Z",
        fill: "currentFill"
      )
    )
    concat(
      tag.span(@label, class: screen_reader_classes)
    )
  end
end