primer_view_components 0.0.38 → 0.0.39

data/app/components/primer/button_group.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use ButtonGroup to render a series of buttons.
+  # Use `ButtonGroup` to render a series of buttons.
   class ButtonGroup < Primer::Component
     status :beta
 

data/app/components/primer/button_marketing_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use buttons for actions (e.g. in forms). Use links for destinations, or moving from one page to another.
+  # Use `ButtonMarketing` for actions (e.g. in forms). Use links for destinations, or moving from one page to another.
   class ButtonMarketingComponent < Primer::Component
     DEFAULT_SCHEME = :default
     SCHEME_MAPPINGS = {

data/app/components/primer/clipboard_copy.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use ClipboardCopy to copy element text content or input values to the clipboard.
+  # Use `ClipboardCopy` to copy element text content or input values to the clipboard.
   class ClipboardCopy < Primer::Component
     status :alpha
 

data/app/components/primer/clipboard_copy_component.js

@@ -10,12 +10,10 @@ function toggleSVG(svg) {
 // Toggle a copy button.
 function toggleCopyButton(button) {
     const [clippyIcon, checkIcon] = button.querySelectorAll('.octicon');
-    if (clippyIcon) {
-        toggleSVG(clippyIcon);
-    }
-    if (checkIcon) {
-        toggleSVG(checkIcon);
-    }
+    if (!clippyIcon || !checkIcon)
+        return;
+    toggleSVG(clippyIcon);
+    toggleSVG(checkIcon);
 }
 document.addEventListener('clipboard-copy', function ({ target }) {
     if (!(target instanceof HTMLElement))

data/app/components/primer/clipboard_copy_component.ts

@@ -12,12 +12,10 @@ function toggleSVG(svg: SVGElement) {
 function toggleCopyButton(button: HTMLElement) {
   const [clippyIcon, checkIcon] = button.querySelectorAll<SVGElement>('.octicon')
 
-  if (clippyIcon) {
-    toggleSVG(clippyIcon)
-  }
-  if (checkIcon) {
-    toggleSVG(checkIcon)
-  }
+  if (!clippyIcon || !checkIcon) return
+
+  toggleSVG(clippyIcon)
+  toggleSVG(checkIcon)
 }
 
 document.addEventListener('clipboard-copy', function ({target}) {

data/app/components/primer/close_button.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use CloseButton to render an `×` without default button styles.
+  # Use `CloseButton` to render an `×` without default button styles.
   #
   # @accessibility
-  #   CloseButton has a default `aria-label` of "Close" to provides assistive technologies with an accessible label.
+  #   `CloseButton` has a default `aria-label` of "Close" to provides assistive technologies with an accessible label.
   #   You may choose to override this label with something more descriptive via [system_arguments][0].
   # [0]: https://primer.style/view-components/system-arguments#html-attributes
   class CloseButton < Primer::Component
+    status :beta
+
     DEFAULT_TYPE = :button
     TYPE_OPTIONS = [DEFAULT_TYPE, :submit].freeze
 

data/app/components/primer/component.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "octicons_helper/helper"
 require "view_component/version"
 
 module Primer
@@ -9,10 +8,25 @@ module Primer
     include ViewComponent::SlotableV2 unless ViewComponent::VERSION::STRING.to_f >= 2.28
     include ClassNameHelper
     include FetchOrFallbackHelper
-    include OcticonsHelper
     include TestSelectorHelper
     include JoinStyleArgumentsHelper
     include ViewHelper
     include Status::Dsl
+
+    private
+
+    def deprecated_component_warning(new_class: nil, version: nil)
+      return if Rails.env.production? || silence_deprecations?
+
+      message = "#{self.class.name} is deprecated"
+      message += " and will be removed in v#{version}." if version
+      message += " Use #{new_class.name} instead." if new_class
+
+      ActiveSupport::Deprecation.warn(message)
+    end
+
+    def silence_deprecations?
+      Rails.application.config.primer_view_components.silence_deprecations
+    end
   end
 end

data/app/components/primer/counter_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use Primer::CounterComponent to add a count to navigational elements and buttons.
+  # Use `CounterComponent` to add a count to navigational elements and buttons.
   class CounterComponent < Primer::Component
     status :beta
 

data/app/components/primer/details_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use DetailsComponent to reveal content after clicking a button.
+  # Use `DetailsComponent` to reveal content after clicking a button.
   class DetailsComponent < Primer::Component
     status :beta
 

data/app/components/primer/dropdown/menu_component.rb

@@ -2,7 +2,7 @@
 
 module Primer
   module Dropdown
-    # This component is part of `Primer::DropdownComponent` and should not be
+    # This component is part of `Dropdown` and should not be
     # used as a standalone component.
     class MenuComponent < Primer::Component
       SCHEME_DEFAULT = :default

data/app/components/primer/dropdown_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Dropdowns are lightweight context menus for housing navigation and actions.
+  # `Dropdown` is a lightweight context menu for housing navigation and actions.
   # They're great for instances where you don't need the full power (and code) of the select menu.
   class DropdownComponent < Primer::Component
     # Required trigger for the dropdown. Only accepts a content.

data/app/components/primer/flash_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use the Flash component to inform users of successful or pending actions.
+  # Use `Flash` to inform users of successful or pending actions.
   class FlashComponent < Primer::Component
     status :beta
 

data/app/components/primer/flex_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use FlexComponent to make an element lay out its content using the flexbox model.
+  # Use `Flex` to make an element lay out its content using the flexbox model.
   # Before using these utilities, you should be familiar with CSS3 Flexible Box
   # spec. If you are not, check out MDN's guide  [Using CSS Flexible
   # Boxes](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox).

data/app/components/primer/flex_item_component.rb

@@ -1,9 +1,26 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use FlexItemComponent to specify the ability of a flex item to alter its
+  # Use `FlexItem` to specify the ability of a flex item to alter its
   # dimensions to fill available space
+  #
+  # @deprecated
+  #   Use <%= link_to_component(Primer::BoxComponent) %> instead.
+  #
+  #   **Before**:
+  #
+  #   ```erb
+  #   <%%= render Primer::FlexItemComponent.new(flex_auto: :auto) %>
+  #   ```
+  #
+  #   **After**:
+  #
+  #   ```erb
+  #   <%%= render Primer::BoxComponent.new(flex: :auto) %>
+  #   ```
   class FlexItemComponent < Primer::Component
+    status :deprecated
+
     FLEX_AUTO_DEFAULT = false
     FLEX_AUTO_ALLOWED_VALUES = [FLEX_AUTO_DEFAULT, true].freeze
 
@@ -21,6 +38,8 @@ module Primer
     # @param flex_auto [Boolean] Fills available space and auto-sizes based on the content. Defaults to <%= Primer::FlexItemComponent::FLEX_AUTO_DEFAULT %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(flex_auto: FLEX_AUTO_DEFAULT, **system_arguments)
+      deprecated_component_warning(new_class: Primer::BoxComponent, version: "0.0.39")
+
       @system_arguments = system_arguments
       @system_arguments[:classes] =
         class_names(

data/app/components/primer/heading_component.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 module Primer
-  # Heading can be used to communicate page organization and hierarchy.
+  # `Heading` can be used to communicate page organization and hierarchy.
   #
   # - Set tag to one of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, `:h6` based on what is
   #   appropriate for the page context.
-  # - Use Heading as the title of a section or sub section.
-  # - Do not use Heading for styling alone. To style text without conveying heading semantics,
+  # - Use `Heading` as the title of a section or sub section.
+  # - Do not use `Heading` for styling alone. To style text without conveying heading semantics,
   #   consider using <%= link_to_component(Primer::TextComponent) %> with relevant <%= link_to_typography_docs %>.
   # - Do not jump heading levels. For instance, do not follow a `<h1>` with an `<h3>`. Heading levels should
   #   increase by one in ascending order.

data/app/components/primer/hidden_text_expander.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use HiddenTextExpander to indicate and toggle hidden text.
+  # Use `HiddenTextExpander` to indicate and toggle hidden text.
   class HiddenTextExpander < Primer::Component
     # @example Default
     #   <%= render(Primer::HiddenTextExpander.new) %>

data/app/components/primer/icon_button.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use `IconButton` to render Icon-only buttons without the default button styles.
+  #
+  # @accessibility
+  #   `IconButton` requires an `aria-label`, which will provide assistive technologies with an accessible label.
+  class IconButton < Primer::Component
+    DEFAULT_SCHEME = :default
+    SCHEME_MAPPINGS = {
+      DEFAULT_SCHEME => "",
+      :danger => "btn-octicon-danger"
+    }.freeze
+    SCHEME_OPTIONS = SCHEME_MAPPINGS.keys
+    # @example Default
+    #
+    #   <%= render(Primer::IconButton.new(icon: :search, "aria-label": "Search")) %>
+    #
+    # @example Schemes
+    #
+    #   <%= render(Primer::IconButton.new(icon: :search, "aria-label": "Search")) %>
+    #   <%= render(Primer::IconButton.new(icon: :trash, "aria-label": "Delete", scheme: :danger)) %>
+    #
+    # @param scheme [Symbol] <%= one_of(Primer::IconButton::SCHEME_OPTIONS) %>
+    # @param icon [String] Name of <%= link_to_octicons %> to use.
+    # @param tag [Symbol] <%= one_of(Primer::BaseButton::TAG_OPTIONS) %>
+    # @param type [Symbol] <%= one_of(Primer::BaseButton::TYPE_OPTIONS) %>
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(scheme: DEFAULT_SCHEME, icon:, **system_arguments)
+      @icon = icon
+
+      @system_arguments = system_arguments
+      @system_arguments[:classes] = class_names(
+        "btn-octicon",
+        SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_OPTIONS, scheme, DEFAULT_SCHEME)],
+        system_arguments[:classes]
+      )
+
+      raise ArgumentError, "`aria-label` is required." if @system_arguments[:"aria-label"].nil? && !Rails.env.production?
+    end
+
+    def call
+      render(Primer::BaseButton.new(**@system_arguments)) do
+        render(Primer::OcticonComponent.new(icon: @icon))
+      end
+    end
+  end
+end

data/app/components/primer/label_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use labels to add contextual metadata to a design.
+  # Use `Label` to add contextual metadata to a design.
   class LabelComponent < Primer::Component
     status :beta
 

data/app/components/primer/layout_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use Layout to build a main/sidebar layout.
+  # Use `Layout` to build a main/sidebar layout.
   class LayoutComponent < Primer::Component
     # The main content
     #

data/app/components/primer/link_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use links for moving from one page to another. The Link component styles anchor tags with default blue styling and hover text-decoration.
+  # Use `Link` for navigating from one page to another. `Link` styles anchor tags with default blue styling and hover text-decoration.
   class LinkComponent < Primer::Component
     status :beta
 

data/app/components/primer/markdown_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use MarkdownComponent to wrap markdown content
+  # Use `Markdown` to wrap markdown content
   class MarkdownComponent < Primer::Component
     # @example Default
     #   <%= render(Primer::MarkdownComponent.new) do %>

data/app/components/primer/menu_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use menus to create vertical lists of navigational links.
+  # Use `Menu` to create vertical lists of navigational links.
   class MenuComponent < Primer::Component
     # Optional menu heading
     #

data/app/components/primer/octicon_component.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+require "octicons"
+
 module Primer
-  # Renders an [Octicon](https://primer.style/octicons/) with <%= link_to_system_arguments_docs %>.
+  # `Octicon` renders an <%= link_to_octicons %> with <%= link_to_system_arguments_docs %>.
   class OcticonComponent < Primer::Component
     status :beta
 
@@ -23,24 +25,47 @@ module Primer
     # @example Large
     #   <%= render(Primer::OcticonComponent.new("x", size: :large)) %>
     #
-    # @param icon [String] Name of [Octicon](https://primer.style/octicons/) to use.
+    # @param icon [String] Name of <%= link_to_octicons %> to use.
     # @param size [Symbol] <%= one_of(Primer::OcticonComponent::SIZE_MAPPINGS) %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(icon_name = nil, icon: nil, size: SIZE_DEFAULT, **system_arguments)
-      @icon = icon_name || icon
+      icon_key = icon_name || icon
+      cache_key = [icon_key, size, system_arguments.slice(:height, :width)].join("_")
+
       @system_arguments = system_arguments
+      @system_arguments[:tag] = :svg
+      @system_arguments[:aria] ||= {}
+
+      if @system_arguments[:aria][:label] || @system_arguments[:"aria-label"]
+        @system_arguments[:role] = "img"
+      else
+        @system_arguments[:aria][:hidden] = true
+      end
 
-      @system_arguments[:class] = Primer::Classify.call(**@system_arguments)[:class]
-      @system_arguments[:height] ||= SIZE_MAPPINGS[size]
+      if (cache_icon = Primer::Octicon::Cache.read(cache_key))
+        @icon = cache_icon
+      else
+        # Filter out classify options to prevent them from becoming invalid html attributes.
+        # Note height and width are both classify options and valid html attributes.
+        octicon_options = {
+          height: SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, size, SIZE_DEFAULT)]
+        }.merge(@system_arguments.slice(:height, :width))
 
-      # Filter out classify options to prevent them from becoming invalid html attributes.
-      # Note height and width are both classify options and valid html attributes.
-      octicon_helper_options = @system_arguments.slice(:height, :width)
-      @system_arguments = add_test_selector(@system_arguments).except(*Primer::Classify::VALID_KEYS, :classes).merge(octicon_helper_options)
+        @icon = Octicons::Octicon.new(icon_key, octicon_options)
+        Primer::Octicon::Cache.set(cache_key, @icon)
+      end
+
+      @system_arguments[:classes] = class_names(
+        @icon.options[:class],
+        @system_arguments[:classes]
+      )
+      @system_arguments.merge!(@icon.options.except(:class, :'aria-hidden'))
     end
 
     def call
-      octicon(@icon, { **@system_arguments })
+      render(Primer::BaseComponent.new(**@system_arguments)) { @icon.path.html_safe } # rubocop:disable Rails/OutputSafety
     end
+
+    Primer::Octicon::Cache.preload!
   end
 end

data/app/components/primer/popover_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use popovers to bring attention to specific user interface elements, typically to suggest an action or to guide users through a new experience.
+  # Use `Popover` to bring attention to specific user interface elements, typically to suggest an action or to guide users through a new experience.
   #
   # By default, the popover renders with absolute positioning, meaning it should usually be wrapped in an element with a relative position in order to be positioned properly. To render the popover with relative positioning, use the relative property.
   class PopoverComponent < Primer::Component

data/app/components/primer/progress_bar_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use ProgressBar to visualize task completion.
+  # Use `ProgressBar` to visualize task completion.
   class ProgressBarComponent < Primer::Component
     status :beta
 

data/app/components/primer/spinner_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use Primer::SpinnerComponent to let users know that content is being loaded.
+  # Use `Spinner` to let users know that content is being loaded.
   class SpinnerComponent < Primer::Component
     status :beta
 

data/app/components/primer/state_component.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  # Component for rendering the status of an item.
+  # Use `State` for rendering the status of an item.
   class StateComponent < Primer::Component
     status :beta