Class: Yattho::Alpha::AutoComplete::Item

Inherits:
Component
  • Object
show all
Defined in:
app/components/yattho/alpha/auto_complete/item.rb

Overview

Use ‘AutoCompleteItem` to list results of an auto-completed search.

Constant Summary

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Constructor Details

#initialize(value:, selected: false, disabled: false, **system_arguments) ⇒ Item

Returns a new instance of Item.

Examples:

Default

<%= render(Yattho::Alpha::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--custom-results", list_id: "fruits-popup--custom-results")) do |component| %>
  <% component.results(classes: "custom-class") do %>
    <%= render(Yattho::Alpha::AutoComplete::Item.new(selected: true, value: "apple")) do %>
      Apple
    <% end %>
    <%= render(Yattho::Alpha::AutoComplete::Item.new(value: "orange")) do %>
      Orange
    <% end %>
  <% end %>
<% end %>

Parameters:

  • value (String) —

    Value of the item.

  • selected (Boolean) (defaults to: false) —

    Whether the item is selected.

  • disabled (Boolean) (defaults to: false) —

    Whether the item is disabled.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'app/components/yattho/alpha/auto_complete/item.rb', line 26

def initialize(value:, selected: false, disabled: false, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :li
  @system_arguments[:role] = :option
  @system_arguments[:'data-autocomplete-value'] = value
  @system_arguments[:'aria-selected'] = true if selected
  @system_arguments[:'aria-disabled'] = true if disabled
  @system_arguments[:classes] = class_names(
    "autocomplete-item",
    system_arguments[:classes],
    "disabled" => disabled
  )
end

Instance Method Details

#call ⇒ Object 



40
41
42
 
# File 'app/components/yattho/alpha/auto_complete/item.rb', line 40

def call
  render(Yattho::BaseComponent.new(**@system_arguments)) { content }
end