Class: Primer::AutoComplete

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

Overview

Use ‘AutoComplete` to provide a user with a list of selectable suggestions that appear when they type into the input field. This list is populated by server search results.

Defined Under Namespace

Classes: Input, Item

Constant Summary

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(src:, list_id:, input_id:, **system_arguments) ⇒ AutoComplete

Returns a new instance of AutoComplete.

Examples:

Default

<%= render(Primer::AutoComplete.new(src: "/auto_complete", input_id: "fruits-input-1", list_id: "fruits-popup-1", position: :relative)) do |c| %>
  <% c.label(classes:"").with_content("Fruits") %>
  <% c.input(type: :text) %>
<% end %>

With ‘aria-label`

<%= render(Primer::AutoComplete.new("aria-label": "Fruits", src: "/auto_complete", input_id: "fruits-input-2", list_id: "fruits-popup-2", position: :relative)) do |c| %>
  <% c.input(type: :text) %>
<% end %>

With ‘aria-labelledby`

<%= render(Primer::HeadingComponent.new(tag: :h2, id: "search-1")) { "Search" } %>
<%= render(Primer::AutoComplete.new(src: "/auto_complete", input_id: "fruits-input-3", list_id: "fruits-popup-2", position: :relative)) do |c| %>
  <% c.input("aria-labelledby": "search-1") %>
<% end %>

With custom classes for the results

<%= render(Primer::AutoComplete.new(src: "/auto_complete", input_id: "fruits-input-4", list_id: "fruits-popup-3", position: :relative)) do |c| %>
  <% c.label(classes:"").with_content("Fruits") %>
  <% c.input(type: :text) %>
  <% c.results(classes: "custom-class") do %>
    <%= render(Primer::AutoComplete::Item.new(selected: true, value: "apple")) do |c| %>
      Apple
    <% end %>
    <%= render(Primer::AutoComplete::Item.new(value: "orange")) do |c| %>
      Orange
    <% end %>
  <% end %>
<% end %>

With Icon

<%= render(Primer::AutoComplete.new(src: "/auto_complete", list_id: "fruits-popup-4", input_id: "fruits-input-4", position: :relative)) do |c| %>
  <% c.label(classes:"").with_content("Fruits") %>
  <% c.input(type: :text) %>
  <% c.icon(icon: :search) %>
<% end %>

Parameters:

  • src (String) —

    The route to query.

  • input_id (String) —

    Id of the input element.

  • list_id (String) —

    Id of the list element.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/components/primer/auto_complete.rb', line 105

def initialize(src:, list_id:, input_id:, **system_arguments)
  @list_id = list_id
  @input_id = input_id
  @aria_label = system_arguments[:"aria-label"] || system_arguments.dig(:aria, :label)

  system_arguments.delete(:"aria-label") && system_arguments[:aria]&.delete(:label)

  @system_arguments = system_arguments
  @system_arguments[:tag] = "auto-complete"
  @system_arguments[:src] = src
  @system_arguments[:for] = list_id
end

Instance Method Details

#before_render ⇒ Object

add ‘results` without needing to explicitly call it in the view

Raises:

  • (ArgumentError) 


119
120
121
122
123
124
 
# File 'app/components/primer/auto_complete.rb', line 119

def before_render
  raise ArgumentError, "Missing `input` slot" if input.blank?
  raise ArgumentError, "Accessible label is required." if label.blank? && input.missing_label?

  results(classes: "") unless results
end