Class: Primer::Beta::AutoComplete::Item

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

Overview

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

Constant Summary collapse

DEFAULT_DESCRIPTION_VARIANT = 
:block
DESCRIPTION_VARIANT_MAPPINGS = 
{
  :inline => "ActionListItem-descriptionWrap--inline",
  DEFAULT_DESCRIPTION_VARIANT => "ActionListItem-descriptionWrap"
}.freeze
DESCRIPTION_VARIANT_OPTIONS = 
DESCRIPTION_VARIANT_MAPPINGS.keys.freeze

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

Constants included from AttributesHelper

AttributesHelper::PLURAL_ARIA_ATTRIBUTES, AttributesHelper::PLURAL_DATA_ATTRIBUTES

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

Methods included from AttributesHelper

#aria, #data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Constructor Details

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

Returns a new instance of Item.

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.

  • description_variant (Hash) (defaults to: DEFAULT_DESCRIPTION_VARIANT) —

    Changes the description style. Allowed values are :inline, :block

  • description (String) —

    Display description text below label

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'app/components/primer/beta/auto_complete/item.rb', line 48

def initialize(value:, selected: false, disabled: false, description_variant: DEFAULT_DESCRIPTION_VARIANT, **system_arguments)
  @description_variant = fetch_or_fallback(
    DESCRIPTION_VARIANT_OPTIONS, description_variant, DEFAULT_DESCRIPTION_VARIANT
  )

  @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(
    "ActionListItem",
    system_arguments[:classes]
  )

  @description_wrapper_arguments = {
    classes: class_names(
      "ActionListItem-descriptionWrap",
      DESCRIPTION_VARIANT_MAPPINGS[@description_variant]
    )
  }
end