Class: Daisy::Actions::SwapComponent

Inherits:

LocoMotion::BaseComponent

• Object
• ViewComponent::Base
• LocoMotion::BaseComponent
• Daisy::Actions::SwapComponent

Includes:

LocoMotion::Concerns::TippableComponent

Defined in:

app/components/daisy/actions/swap_component.rb

Overview

Note:

Includes the LocoMotion::Concerns::TippableComponent module to enable easy tooltip addition.

The Swap component allows toggling between two states, "on" and "off", with an optional indeterminate state. It provides a flexible way to create animated toggles, switches, or any other element that needs to alternate between different visual states. The component supports both simple text/emoji swaps and complex HTML content swaps.

It also includes built-in animations that can be enabled through CSS classes like swap-rotate or swap-flip.

Defined Under Namespace

Classes: SwapIndeterminate, SwapOff, SwapOn

Constant Summary

Constants inherited from LocoMotion::BaseComponent

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

Instance Attribute Summary

• #simple_off ⇒ String readonly

  The value of the off option.

• #simple_on ⇒ String readonly

  The value of the on option.

Attributes inherited from LocoMotion::BaseComponent

#config, #loco_parent

Instance Method Summary

• #before_render ⇒ Object

  Sets up the component with various CSS classes and HTML attributes.

• #initialize(on = nil, off = nil, checked = nil, **kws, &block) ⇒ SwapComponent constructor

  Creates a new instance of the SwapComponent.

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

Methods included from LocoMotion::Concerns::InspectableComponent

#build_inspect_string

Constructor Details

#initialize(on = nil, off = nil, checked = nil, **kws, &block) ⇒ SwapComponent

Creates a new instance of the SwapComponent.

Parameters:

• on (String) (defaults to: nil) —

  Simple text/emoji to display in the "on" state. If provided along with off, enables simple text swap mode.

• off (String) (defaults to: nil) —

  Simple text/emoji to display in the "off" state. If provided along with on, enables simple text swap mode.

• checked (Boolean) (defaults to: nil) —

  Whether the swap should start in the checked ("on") state. Defaults to false.

• kws (Hash) —

  The keyword arguments for the component.

Options Hash (**kws):

• on (String) —

  Simple text/emoji for the "on" state. Alternative to providing it as the first argument.

• off (String) —

  Simple text/emoji for the "off" state. Alternative to providing it as the second argument.

• checked (Boolean) —

  Whether the swap should start checked. Alternative to providing it as the third argument.

• tip (String) —

  The tooltip text to display when hovering over the component.

# File 'app/components/daisy/actions/swap_component.rb', line 125

def initialize(on = nil, off = nil, checked = nil, **kws, &block)
  super

  @checked = config_option(:checked, checked || false)
  @simple_on = config_option(:on, on)
  @simple_off = config_option(:off, off)
end

Instance Attribute Details

#simple_off ⇒ String (readonly)

Returns The value of the off option. Usually text or emoji.

Returns:

• (String) —

  The value of the off option. Usually text or emoji.

# File 'app/components/daisy/actions/swap_component.rb', line 97

def simple_off
  @simple_off
end

#simple_on ⇒ String (readonly)

Returns The value of the on option. Usually text or emoji.

Returns:

• (String) —

  The value of the on option. Usually text or emoji.

# File 'app/components/daisy/actions/swap_component.rb', line 94

def simple_on
  @simple_on
end

Instance Method Details

#before_render ⇒ Object

Sets up the component with various CSS classes and HTML attributes.

# File 'app/components/daisy/actions/swap_component.rb', line 136

def before_render
  setup_component # Set tag, base CSS
  setup_checkbox  # Setup the hidden checkbox part
  setup_on_off    # Setup the on/off part CSS
  super           # Run TippableComponent hook
end