primer_view_components 0.0.74 → 0.0.75

data/app/components/primer/beta/auto_complete/auto_complete.html.erb

@@ -1,24 +1,26 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <label for="<%= @input_id %>" class="<%= @label_classes %>">
-    <% if @is_label_visible %>
+  <div class="<%= @form_group_classes %>">
+    <label for="<%= @input_id %>" class="FormControl-label <% if @visually_hide_label %>sr-only<% end %>">
       <%= @label_text %>
+    </label>
+    <% if leading_visual || @show_clear_button %>
+        <div class="<%= @field_wrap_classes %> <% if leading_visual %>FormControl-fieldWrap--input-leadingVisual<% end %>">
+            <%= leading_visual %>
+            <%= input %>
+            <% if @show_clear_button %>
+              <button id="<%= @input_id %>-clear" class="FormControl--input-trailingAction" aria-label="Clear"><%= primer_octicon "x-circle-fill" %></button>
+            <% end %>
+        </div>
     <% else %>
-      <span class="sr-only"><%= @label_text %></span>
+      <%= input %>
     <% end %>
-  </label>
-  <span class="autocomplete-body">
-    <% if @with_icon %>
-      <div class="form-control autocomplete-embedded-icon-wrap">
-        <%= render Primer::OcticonComponent.new(:search) %>
-    <% end %>
-    <%= input %>
-    <% if @is_clearable %>
-      <button id="<%= @input_id %>-clear" class="btn-octicon" aria-label="Clear"><%= primer_octicon "x" %></button>
-    <% end %>
-    <% if @with_icon %>
+  </div>
+  <div class="Overlay-backdrop--anchor">
+    <div class="Overlay Overlay--height-auto Overlay--width-auto">
+      <div class="Overlay-body Overlay-body--paddingNone">
+        <%= results %>
       </div>
-    <% end %>
-    <%= results %>
-  </span>
+    </div>
+  </div>
   <div id="<%= @list_id %>-feedback" class="sr-only"></div>
 <% end %>

data/app/components/primer/beta/auto_complete/item.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# TODO: use generic ActionList item for Autocomplete
 module Primer
   module Beta
     class AutoComplete
@@ -29,14 +30,17 @@ module Primer
           @system_arguments[:"aria-disabled"] = true if disabled
 
           @system_arguments[:classes] = class_names(
-            "autocomplete-item",
-            system_arguments[:classes],
-            "disabled" => disabled
+            "ActionList-item",
+            system_arguments[:classes]
           )
         end
 
         def call
-          render(Primer::BaseComponent.new(**@system_arguments)) { content }
+          render(Primer::BaseComponent.new(**@system_arguments)) do
+            render(Primer::BaseComponent.new(tag: :span, classes: "ActionList-content")) do
+              render(Primer::BaseComponent.new(tag: :span, classes: "ActionList-item-label")) { content }
+            end
+          end
         end
       end
     end

data/app/components/primer/beta/auto_complete.rb

@@ -8,11 +8,20 @@ module Primer
     #   Always set an accessible label to help the user interact with the component.
     #
     #   * `label_text` is required and visible by default.
-    #   * If you must use a non-visible label, set `is_label_visible` to `false`.
+    #   * If you must hide the label, set `visually_hide_label` to `true`.
     #   However, please note that a visible label should almost always
     #   be used unless there is compelling reason not to. A placeholder is not a label.
     class AutoComplete < Primer::Component
       status :beta
+
+      DEFAULT_SIZE = :medium
+      SIZE_MAPPINGS = {
+        :small => "FormControl--small",
+        DEFAULT_SIZE => "FormControl--medium",
+        :large => "FormControl--large"
+      }.freeze
+      SIZE_OPTIONS = SIZE_MAPPINGS.keys
+
       #
       # Customizable results list.
       #
@@ -22,13 +31,26 @@ module Primer
         system_arguments[:tag] = :ul
         system_arguments[:id] = @list_id
         system_arguments[:classes] = class_names(
-          "autocomplete-results",
+          "ActionList",
           system_arguments[:classes]
         )
 
         Primer::BaseComponent.new(**system_arguments)
       }
 
+      #
+      # Leading visual.
+      #
+      # - `leading_visual_icon` for a <%= link_to_component(Primer::OcticonComponent) %>.
+      #
+      # @param system_arguments [Hash] Same arguments as <%= link_to_component(Primer::OcticonComponent) %>.
+      renders_one :leading_visual, types: {
+        icon: lambda { |**system_arguments|
+          system_arguments[:classes] = class_names("FormControl--input-leadingVisual")
+          Primer::OcticonComponent.new(**system_arguments)
+        }
+      }
+
       # Customizable input used to search for results.
       # It is preferred to use this slot sparingly - it will be created by default if not explicity added.
       #
@@ -38,7 +60,7 @@ module Primer
         sanitized_args = deny_single_argument(:autofocus, "autofocus is not allowed for accessibility reasons. See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus#accessibility_considerations for more information.", **sanitized_args)
         deny_aria_key(
           :label,
-          "instead of `aria-label`, include `label_text` and set `is_label_visible` to `false` on the component initializer.",
+          "instead of `aria-label`, include `label_text` and set `visually_hide_label` to `true` on the component initializer.",
           **sanitized_args
         )
         deny_single_argument(
@@ -55,45 +77,82 @@ module Primer
         sanitized_args[:name] = @input_name
         sanitized_args[:tag] = :input
         sanitized_args[:autocomplete] = "off"
-
+        sanitized_args[:disabled] = true if @disabled
+        sanitized_args[:invalid] = true if @invalid
         sanitized_args[:type] = :text
         sanitized_args[:classes] = class_names(
-          "form-control",
+          "FormControl",
+          "FormControl--input",
+          SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, @size, DEFAULT_SIZE)],
           sanitized_args[:classes]
         )
+        sanitized_args[:placeholder] = @placeholder
 
         Primer::BaseComponent.new(**sanitized_args)
       }
 
-      # @example Default
+      # @example Leading visual
       #   @description
-      #     Labels are stacked by default.
+      #     Display any Octicon as a leading visual within the field
       #   @code
-      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--default", list_id: "fruits-popup--default")) %>
+      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Select a fruit", src: "/auto_complete", input_id:"input-id-1", list_id: "list-id-1")) do |c| %>
+      #       <% c.leading_visual_icon(icon: :search) %>
+      #       <% c.results do %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(selected: true, value: "apple")) do |_c| %>
+      #           Apple
+      #         <% end %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(value: "orange")) do |_c| %>
+      #           Orange
+      #         <% end %>
+      #       <% end %>
+      #     <% end %>
       #
-      # @example With inline label
+      # @example Trailing action
       #   @description
-      #     Labels can be inline by setting `is_label_inline: true`. However, labels will always become stacked on smaller screen sizes.
+      #     Show a clear button
       #   @code
-      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", is_label_inline: true, input_id: "fruits-input--inline-label", list_id: "fruits-popup--inline-label")) %>
+      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Select a fruit", input_id: "input-id-2", list_id: "list-id-2", src: "/auto_complete", show_clear_button: true )) do |c| %>
+      #       <% c.results do %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(selected: true, value: "apple")) do |_c| %>
+      #           Apple
+      #         <% end %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(value: "orange")) do |_c| %>
+      #           Orange
+      #         <% end %>
+      #       <% end %>
+      #     <% end %>
       #
-      # @example With non-visible label
+      # @example Visually hidden label
       #   @description
-      #     A non-visible label may be rendered with `is_label_visible: false`, but it is highly discouraged. See <%= link_to_accessibility %>.
+      #     A non-visible label may be rendered with `visually_hide_label: true`, but it is highly discouraged. See <%= link_to_accessibility %>.
       #   @code
-      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--non-visible-label", list_id: "fruits-popup--non-visible-label", is_label_visible: false)) %>
+      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Select a fruit", input_id: "fruits-input--custom-results-1", list_id: "fruits-popup--custom-result-1", src: "/auto_complete", visually_hide_label: true)) do |c| %>
+      #       <% c.leading_visual_icon(icon: :search) %>
+      #       <% c.results do %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(selected: true, value: "apple")) do |_c| %>
+      #           Apple
+      #         <% end %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(value: "orange")) do |_c| %>
+      #           Orange
+      #         <% end %>
+      #       <% end %>
+      #     <% end %>
       #
-      # @example With icon
+      # @example Full width field
       #   @description
-      #     To display a search icon, set `with_icon` to `true`.
+      #     To allow field to span width of its container, set `full_width` to `true`.
       #   @code
-      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", list_id: "fruits-popup--icon", input_id: "fruits-input--icon", with_icon: true)) %>
-      #
-      # @example With icon and non-visible label
-      #   <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", list_id: "fruits-popup--icon-no-label", input_id: "fruits-input--icon-no-label", with_icon: true, is_label_visible: false)) %>
-      #
-      # @example With clear button
-      #   <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--clear", list_id: "fruits-popup--clear", is_clearable: true)) %>
+      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Select a fruit", input_id: "fruits-input--custom-results-2", list_id: "fruits-popup--custom-results-2", src: "/auto_complete", full_width: true)) do |c| %>
+      #       <% c.leading_visual_icon(icon: :search) %>
+      #       <% c.results do %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(selected: true, value: "apple")) do |_c| %>
+      #           Apple
+      #         <% end %>
+      #         <%= render(Primer::Beta::AutoComplete::Item.new(value: "orange")) do |_c| %>
+      #           Orange
+      #         <% end %>
+      #       <% end %>
+      #     <% end %>
       #
       # @example With custom classes for the input
       #   <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--custom-input", list_id: "fruits-popup--custom-input")) do |c| %>
@@ -117,25 +176,42 @@ module Primer
       # @param input_id [String] Id of the input element.
       # @param input_name [String] Optional name of the input element, defaults to `input_id` when not set.
       # @param list_id [String] Id of the list element.
-      # @param with_icon [Boolean] Controls if a search icon is visible, defaults to `false`.
-      # @param is_label_visible [Boolean] Controls if the label is visible. If `false`, screen reader only text will be added.
-      # @param is_clearable [Boolean] Adds optional clear button.
-      # @param is_label_inline [Boolean] Controls if the label is inline. On smaller screens, label will always become stacked.
+      # @param visually_hide_label [Boolean] Controls if the label is visible. If `true`, screen reader only text will be added.
+      # @param show_clear_button [Boolean] Adds optional clear button.
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(label_text:, src:, list_id:, input_id:, input_name: nil, is_label_visible: true, is_label_inline: false, with_icon: false, is_clearable: false, **system_arguments)
+      # @param size [Hash] Input size can be small, medium (default), or large
+      # @param full_width [Boolean] Input can be full-width or fit to content
+      # @param disabled [Boolean] Disabled input
+      # @param invalid [Boolean] Invalid input
+      # @param placeholder [String] The placeholder text displayed within the input
+      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, disabled: false, invalid: false, **system_arguments)
         @label_text = label_text
         @list_id = list_id
         @input_id = input_id
         @input_name = input_name || input_id
-        @is_label_visible = is_label_visible
-        @with_icon = with_icon
-        @is_clearable = is_clearable
-
-        @label_classes = label_classes(is_label_visible: is_label_visible, is_label_inline: is_label_inline)
+        @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
+        @full_width = full_width
+        @field_wrap_classes = class_names(
+          "FormControl-fieldWrap",
+          "FormControl-fieldWrap--input",
+          SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, @size, DEFAULT_SIZE)],
+          "FormControl-fieldWrap--disabled": disabled,
+          "FormControl-fieldWrap--invalid": invalid,
+          "FormControl-fieldWrap--input-trailingAction": show_clear_button
+        )
+        @form_group_classes = class_names(
+          "FormGroup",
+          "FormGroup--fullWidth": full_width
+        )
       end
 
       # add `input` and `results` without needing to explicitly call them in the view
@@ -143,20 +219,6 @@ module Primer
         results(classes: "") unless results
         input(classes: "") unless input
       end
-
-      private
-
-      # Private: determines the label classes based on component configration.
-      #
-      # If the label is not visible, return an empty string.
-      #
-      # @param args [Hash] The component configuration.
-      # @return [String] The label classes.
-      def label_classes(**args)
-        return "" if args[:is_label_visible] == false
-
-        args[:is_label_inline] ? "autocomplete-label-inline" : "autocomplete-label-stacked"
-      end
     end
   end
 end

data/lib/primer/view_components/version.rb

@@ -5,7 +5,7 @@ module Primer
     module VERSION
       MAJOR = 0
       MINOR = 0
-      PATCH = 74
+      PATCH = 75
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/lib/rubocop/cop/primer/deprecated_arguments.rb

@@ -33,6 +33,16 @@ module RuboCop
         # }
         #
         DEPRECATED = {
+          is_label_inline: nil,
+          with_icon: nil,
+          is_label_visible: {
+            false => "visually_hide_label: true",
+            true => "visually_hide_label: false"
+          },
+          is_clearable: {
+            false => "show_clear_button: false",
+            true => "show_clear_button: true"
+          },
           bg: {
             white: "bg: :primary",
             gray_light: "bg: :secondary",

data/lib/tasks/docs.rake

@@ -343,11 +343,10 @@ namespace :docs do
     nav_yaml = YAML.load_file(nav_yaml_file)
     adr_entry = {
       "title" => "Architecture decisions",
-      "url" => "/adr",
       "children" => nav_entries.compact
     }
 
-    existing_index = nav_yaml.index { |entry| entry["url"] == "/adr" }
+    existing_index = nav_yaml.index { |entry| entry["title"] == "Architecture decisions" }
     if existing_index
       nav_yaml[existing_index] = adr_entry
     else

data/static/arguments.yml

@@ -210,28 +210,39 @@
     type: String
     default: N/A
     description: Id of the list element.
-  - name: with_icon
+  - name: visually_hide_label
     type: Boolean
     default: "`false`"
-    description: Controls if a search icon is visible, defaults to `false`.
-  - name: is_label_visible
-    type: Boolean
-    default: "`true`"
-    description: Controls if the label is visible. If `false`, screen reader only
-      text will be added.
-  - name: is_clearable
+    description: Controls if the label is visible. If `true`, screen reader only text
+      will be added.
+  - name: show_clear_button
     type: Boolean
     default: "`false`"
     description: Adds optional clear button.
-  - name: is_label_inline
-    type: Boolean
-    default: "`false`"
-    description: Controls if the label is inline. On smaller screens, label will always
-      become stacked.
   - name: system_arguments
     type: Hash
     default: N/A
     description: "[System arguments](/system-arguments)"
+  - name: size
+    type: Hash
+    default: "`:medium`"
+    description: Input size can be small, medium (default), or large
+  - name: full_width
+    type: Boolean
+    default: "`false`"
+    description: Input can be full-width or fit to content
+  - name: disabled
+    type: Boolean
+    default: "`false`"
+    description: Disabled input
+  - name: invalid
+    type: Boolean
+    default: "`false`"
+    description: Invalid input
+  - name: placeholder
+    type: String
+    default: "`nil`"
+    description: The placeholder text displayed within the input
 - component: AutoCompleteItem
   source: https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb
   parameters:

data/static/classes.yml

@@ -1,4 +1,8 @@
 ---
+- ".ActionList"
+- ".ActionList-content"
+- ".ActionList-item"
+- ".ActionList-item-label"
 - ".AvatarStack"
 - ".AvatarStack--right"
 - ".AvatarStack--three-plus"
@@ -19,6 +23,18 @@
 - ".Counter"
 - ".Counter--primary"
 - ".Counter--secondary"
+- ".FormControl"
+- ".FormControl--input"
+- ".FormControl--input-leadingVisual"
+- ".FormControl--input-trailingAction"
+- ".FormControl--medium"
+- ".FormControl-fieldWrap"
+- ".FormControl-fieldWrap--input"
+- ".FormControl-fieldWrap--input-leadingVisual"
+- ".FormControl-fieldWrap--input-trailingAction"
+- ".FormControl-label"
+- ".FormGroup"
+- ".FormGroup--fullWidth"
 - ".Label"
 - ".Label--accent"
 - ".Label--attention"
@@ -49,6 +65,12 @@
 - ".Link--muted"
 - ".Link--primary"
 - ".Link--secondary"
+- ".Overlay"
+- ".Overlay--height-auto"
+- ".Overlay--width-auto"
+- ".Overlay-backdrop--anchor"
+- ".Overlay-body"
+- ".Overlay-body--paddingNone"
 - ".Popover"
 - ".Popover-message"
 - ".Popover-message--large"
@@ -82,12 +104,6 @@
 - ".UnderlineNav-item"
 - ".UnderlineNav-octicon"
 - ".anim-rotate"
-- ".autocomplete-body"
-- ".autocomplete-embedded-icon-wrap"
-- ".autocomplete-item"
-- ".autocomplete-label-inline"
-- ".autocomplete-label-stacked"
-- ".autocomplete-results"
 - ".avatar"
 - ".avatar-more"
 - ".avatar-small"
@@ -167,7 +183,6 @@
 - ".flex-justify-center"
 - ".flex-shrink-0"
 - ".float-right"
-- ".form-control"
 - ".gutter-condensed"
 - ".gutter-lg"
 - ".hidden-text-expander"

data/static/constants.json

@@ -199,7 +199,18 @@
     ]
   },
   "Primer::Beta::AutoComplete": {
-    "Item": "Primer::Beta::AutoComplete::Item"
+    "DEFAULT_SIZE": "medium",
+    "Item": "Primer::Beta::AutoComplete::Item",
+    "SIZE_MAPPINGS": {
+      "small": "FormControl--small",
+      "medium": "FormControl--medium",
+      "large": "FormControl--large"
+    },
+    "SIZE_OPTIONS": [
+      "small",
+      "medium",
+      "large"
+    ]
   },
   "Primer::Beta::AutoComplete::Item": {
   },

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.74
+  version: 0.0.75
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-13 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -366,7 +366,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.25
-description:
+description: 
 email:
 - opensource+primer_view_components@github.com
 executables: []
@@ -580,7 +580,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -595,8 +595,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: ViewComponents for the Primer Design System
 test_files: []