primer_view_components 0.0.77 → 0.0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f84596b796b25618ed97b1f6fd73cca3e3d1a379589d06748d167e18a36118b0
-  data.tar.gz: 6d9aa8f0332223a345227263eeae4f71e21724208ceed6fcb7f929e322beb177
+  metadata.gz: 14696807be6f622296821fc11d6d18603697762804b6dcd3d1d9904fb738ab3a
+  data.tar.gz: 6d4fb8b39611673742ee07c3b3ea8efc5b12c32e501aa57300c2269016bfd212
 SHA512:
-  metadata.gz: c1f71999579298bd8e7649ee0be439be3261b6fd76729bdf69dd771381160c0caad8ce7a2fae10c5df49163ba9aabba6741697c81fa7e868f684a19df86290f2
-  data.tar.gz: 4783a639eb3848cbf1f3cf068c4905751bcdfb9ebc4c58ce10d45c16c5c0a85a6eed3cc689e06771176894590eeecba23aeb0cc37bfd35a57494461e7efdd8a6
+  metadata.gz: 13db29020f596d335cc64dfdf018a04896471d73de9d60a175cf68d4414bc671209f66c5de2c9abe03a88f3680ccef9c7ef96e81a3f0b83910be53aaaa64bf53
+  data.tar.gz: fca103d7eaea214d08184b5f959797806d1c5d1f809b9de1a4250cada31b023f92f9a496c2208fc7feb0559b174925c2389c796b6b3af18665aeb4818f788563

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 0.0.78
+
+### Patch Changes
+
+- [#1186](https://github.com/primer/view_components/pull/1186) [`ff2c3fe1`](https://github.com/primer/view_components/commit/ff2c3fe1913d7a1d65dbd4f608b68155ed247bef) Thanks [@joelhawksley](https://github.com/joelhawksley)! - Revert #1163, as additional work will be needed to ship those changes to production successfully.
+
 ## 0.0.77
 
 ### Patch Changes

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

@@ -1,26 +1,24 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <div class="<%= @form_group_classes %>">
-    <label for="<%= @input_id %>" class="FormControl-label <% if @visually_hide_label %>sr-only<% end %>">
+  <label for="<%= @input_id %>" class="<%= @label_classes %>">
+    <% if @is_label_visible %>
       <%= @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 %>
-      <%= input %>
+      <span class="sr-only"><%= @label_text %></span>
     <% end %>
-  </div>
-  <div class="Overlay-backdrop--anchor">
-    <div class="Overlay Overlay--height-auto Overlay--width-auto">
-      <div class="Overlay-body Overlay-body--paddingNone">
-        <%= results %>
+  </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>
-  </div>
+    <% end %>
+    <%= results %>
+  </span>
   <div id="<%= @list_id %>-feedback" class="sr-only"></div>
 <% end %>

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

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

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

@@ -8,20 +8,11 @@ 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 hide the label, set `visually_hide_label` to `true`.
+    #   * If you must use a non-visible label, set `is_label_visible` to `false`.
     #   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.
       #
@@ -31,26 +22,13 @@ module Primer
         system_arguments[:tag] = :ul
         system_arguments[:id] = @list_id
         system_arguments[:classes] = class_names(
-          "ActionList",
+          "autocomplete-results",
           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.
       #
@@ -60,7 +38,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 `visually_hide_label` to `true` on the component initializer.",
+          "instead of `aria-label`, include `label_text` and set `is_label_visible` to `false` on the component initializer.",
           **sanitized_args
         )
         deny_single_argument(
@@ -77,82 +55,45 @@ 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(
-          "FormControl",
-          "FormControl--input",
-          SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, @size, DEFAULT_SIZE)],
+          "form-control",
           sanitized_args[:classes]
         )
-        sanitized_args[:placeholder] = @placeholder
 
         Primer::BaseComponent.new(**sanitized_args)
       }
 
-      # @example Leading visual
+      # @example Default
       #   @description
-      #     Display any Octicon as a leading visual within the field
+      #     Labels are stacked by default.
       #   @code
-      #     <%= 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 %>
+      #     <%= render(Primer::Beta::AutoComplete.new(label_text: "Fruits", src: "/auto_complete", input_id: "fruits-input--default", list_id: "fruits-popup--default")) %>
       #
-      # @example Trailing action
+      # @example With inline label
       #   @description
-      #     Show a clear button
+      #     Labels can be inline by setting `is_label_inline: true`. However, labels will always become stacked on smaller screen sizes.
       #   @code
-      #     <%= 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 %>
+      #     <%= 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")) %>
       #
-      # @example Visually hidden label
+      # @example With non-visible label
       #   @description
-      #     A non-visible label may be rendered with `visually_hide_label: true`, but it is highly discouraged. See <%= link_to_accessibility %>.
+      #     A non-visible label may be rendered with `is_label_visible: false`, but it is highly discouraged. See <%= link_to_accessibility %>.
       #   @code
-      #     <%= 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 %>
+      #     <%= 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)) %>
       #
-      # @example Full width field
+      # @example With icon
       #   @description
-      #     To allow field to span width of its container, set `full_width` to `true`.
+      #     To display a search icon, set `with_icon` to `true`.
       #   @code
-      #     <%= 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 %>
+      #     <%= 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)) %>
       #
       # @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| %>
@@ -176,42 +117,25 @@ 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 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 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 system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      # @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)
+      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)
         @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
+        @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)
         @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
@@ -219,6 +143,20 @@ 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 = 77
+      PATCH = 78
 
       STRING = [MAJOR, MINOR, PATCH].join(".")
     end

data/static/arguments.yml

@@ -210,39 +210,28 @@
     type: String
     default: N/A
     description: Id of the list element.
-  - name: visually_hide_label
+  - name: with_icon
     type: Boolean
     default: "`false`"
-    description: Controls if the label is visible. If `true`, screen reader only text
-      will be added.
-  - name: show_clear_button
+    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
     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,8 +1,4 @@
 ---
-- ".ActionList"
-- ".ActionList-content"
-- ".ActionList-item"
-- ".ActionList-item-label"
 - ".AvatarStack"
 - ".AvatarStack--right"
 - ".AvatarStack--three-plus"
@@ -23,18 +19,6 @@
 - ".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"
@@ -65,12 +49,6 @@
 - ".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"
@@ -104,6 +82,12 @@
 - ".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"
@@ -183,6 +167,7 @@
 - ".flex-justify-center"
 - ".flex-shrink-0"
 - ".float-right"
+- ".form-control"
 - ".gutter-condensed"
 - ".gutter-lg"
 - ".hidden-text-expander"

data/static/constants.json

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: primer_view_components
 version: !ruby/object:Gem::Version
-  version: 0.0.77
+  version: 0.0.78
 platform: ruby
 authors:
 - GitHub Open Source