Method: Primer::Beta::AutoComplete#initialize

Defined in:
app/components/primer/beta/auto_complete.rb

#initialize(label_text:, src:, list_id:, input_id:, input_name: nil, placeholder: nil, show_clear_button: false, visually_hide_label: false, size: DEFAULT_SIZE, full_width: false, width: DEFAULT_WIDTH, disabled: false, invalid: false, inset: false, monospace: false, **system_arguments) ⇒ AutoComplete

Returns a new instance of AutoComplete.

Parameters:

  • label_text (String) —

    The label of the input.

  • src (String) —

    The route to query.

  • input_id (String) —

    Id of the input element.

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

    Optional name of the input element, defaults to ‘input_id` when not set.

  • list_id (String) —

    Id of the list element.

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

    Controls if the label is visible. If ‘true`, screen reader only text will be added.

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

    Adds optional clear button.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>

  • size (Hash) (defaults to: DEFAULT_SIZE) —

    Input size can be small, medium (default), or large

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

    Input can be full-width or fit to content

  • width (String) (defaults to: DEFAULT_WIDTH) —

    Optional parameter to set max width of results list. <%= one_of(Primer::Beta::AutoComplete::WIDTH_OPTIONS) %>

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

    Disabled input

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

    Invalid input

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

    The placeholder text displayed within the input

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

    subtle input background color

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

    monospace input font family



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'app/components/primer/beta/auto_complete.rb', line 126

def initialize(label_text:, src:, list_id:, input_id:, input_name: nil, placeholder: nil, show_clear_button: false, visually_hide_label: false, size: DEFAULT_SIZE, full_width: false, width: DEFAULT_WIDTH, disabled: false, invalid: false, inset: false, monospace: false, **system_arguments)
  @label_text = label_text
  @list_id = list_id
  @input_id = input_id
  @input_name = input_name || input_id
  @placeholder = placeholder
  @visually_hide_label = visually_hide_label
  @show_clear_button = show_clear_button
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = "auto-complete"
  @system_arguments[:src] = src
  @system_arguments[:for] = list_id
  @disabled = disabled
  @invalid = invalid
  @size = size
  @inset = inset
  @monospace = monospace
  @full_width = full_width
  @width = width
  @field_wrap_classes = class_names(
    "FormControl-input-wrap",
    SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, @size, DEFAULT_SIZE)],
    "FormControl-input-wrap--trailingAction": show_clear_button
  )
  @form_group_classes = class_names(
    "FormControl",
    "FormControl--fullWidth": full_width
  )
  @overlay_classes = class_names(
    "Overlay",
    "Overlay--height-auto",
    WIDTH_MAPPINGS[fetch_or_fallback(WIDTH_OPTIONS, @width, DEFAULT_WIDTH)]
  )
end