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

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 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(Primer::Beta::AutoComplete::Item.new(selected: true, value: "value")) do |c| %>
  Selected
<% end %>
<%= render(Primer::Beta::AutoComplete::Item.new(value: "value")) do |c| %>
  Not selected
<% 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 %>



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'app/components/primer/beta/auto_complete/item.rb', line 22

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 



38
39
40
 
# File 'app/components/primer/beta/auto_complete/item.rb', line 38

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