primer_view_components 0.0.31 → 0.0.36

data/app/components/primer/time_ago_component.rb

@@ -3,7 +3,8 @@
 module Primer
   # Use Primer::TimeAgoComponent to display a time relative to how long ago it was. This component requires JavaScript.
   class TimeAgoComponent < Primer::Component
-    #
+    status :beta
+
     # @example Default
     #   <%= render(Primer::TimeAgoComponent.new(time: Time.at(628232400))) %>
     #

data/app/components/primer/timeline_item_component.rb

@@ -3,7 +3,6 @@
 module Primer
   # Use `TimelineItem` to display items on a vertical timeline, connected by badge elements.
   class TimelineItemComponent < Primer::Component
-    include ViewComponent::SlotableV2
     status :beta
 
     # Avatar to be rendered to the left of the Badge.
@@ -78,7 +77,7 @@ module Primer
 
       def call
         render(Primer::BaseComponent.new(**@system_arguments)) do
-          render(Primer::OcticonComponent.new(icon: @icon))
+          render(Primer::OcticonComponent.new(@icon))
         end
       end
     end

data/app/components/primer/{truncate_component.rb → truncate.rb}

@@ -1,21 +1,23 @@
 # frozen_string_literal: true
 
 module Primer
-  # Use TruncateComponent to shorten overflowing text with an ellipsis.
-  class TruncateComponent < Primer::Component
+  # Use Truncate to shorten overflowing text with an ellipsis.
+  class Truncate < Primer::Component
+    status :beta
+
     # @example Default
     #   <div class="col-2">
-    #     <%= render(Primer::TruncateComponent.new(tag: :p)) { "branch-name-that-is-really-long" } %>
+    #     <%= render(Primer::Truncate.new(tag: :p)) { "branch-name-that-is-really-long" } %>
     #   </div>
     #
     # @example Inline
-    #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true)) { "branch-name-that-is-really-long" } %>
+    #   <%= render(Primer::Truncate.new(tag: :span, inline: true)) { "branch-name-that-is-really-long" } %>
     #
     # @example Expandable
-    #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true, expandable: true)) { "branch-name-that-is-really-long" } %>
+    #   <%= render(Primer::Truncate.new(tag: :span, inline: true, expandable: true)) { "branch-name-that-is-really-long" } %>
     #
     # @example Custom size
-    #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true, expandable: true, max_width: 100)) { "branch-name-that-is-really-long" } %>
+    #   <%= render(Primer::Truncate.new(tag: :span, inline: true, expandable: true, max_width: 100)) { "branch-name-that-is-really-long" } %>
     #
     # @param inline [Boolean] Whether the element is inline (or inline-block).
     # @param expandable [Boolean] Whether the entire string should be revealed on hover. Can only be used in conjunction with `inline`.

data/app/components/primer/underline_nav_component.html.erb

@@ -1,11 +1,23 @@
-<%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <% if @align == :right %>
-    <%= actions %>
-  <% end %>
+<%= wrapper do %>
+  <%= render Primer::BaseComponent.new(**@system_arguments) do %>
+    <% if @align == :right %>
+      <%= actions %>
+    <% end %>
+
+    <%= render body do %>
+      <% tabs.each do |tab| %>
+        <%= tab %>
+      <% end %>
+    <% end %>
 
-  <%= body %>
+    <% if @align == :left %>
+      <%= actions %>
+    <% end %>
+  <% end %>
 
-  <% if @align == :left %>
-    <%= actions %>
+  <% if @with_panel %>
+    <% tabs.each do |tab| %>
+      <%= tab.panel %>
+    <% end %>
   <% end %>
 <% end %>

data/app/components/primer/underline_nav_component.rb

@@ -5,34 +5,66 @@ module Primer
   # underlined selected state, typically used for navigation placed at the top
   # of the page.
   class UnderlineNavComponent < Primer::Component
-    include ViewComponent::SlotableV2
+    include Primer::TabbedComponentHelper
 
     ALIGN_DEFAULT = :left
     ALIGN_OPTIONS = [ALIGN_DEFAULT, :right].freeze
 
-    #  Use the body for the navigation items
+    BODY_TAG_DEFAULT = :div
+    BODY_TAG_OPTIONS = [BODY_TAG_DEFAULT, :ul].freeze
+
+    # Use the tabs to list navigation items. For more information, refer to <%= link_to_component(Primer::Navigation::TabComponent) %>.
     #
+    # @param selected [Boolean] Whether the tab is selected.
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    renders_one :body, lambda { |**system_arguments|
-      system_arguments[:classes] = class_names("UnderlineNav-body", "list-style-none", system_arguments[:classes])
-      system_arguments[:tag] ||= :ul
+    renders_many :tabs, lambda { |selected: false, **system_arguments|
+      system_arguments[:classes] = class_names(
+        "UnderlineNav-item",
+        system_arguments[:classes]
+      )
 
-      Primer::BaseComponent.new(**system_arguments) { content }
+      Primer::Navigation::TabComponent.new(
+        list: list?,
+        selected: selected,
+        with_panel: @with_panel,
+        icon_classes: "UnderlineNav-octicon",
+        **system_arguments
+      )
     }
 
-    #  Use actions for a call to action
+    # Use actions for a call to action.
     #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     renders_one :actions, lambda { |**system_arguments|
       system_arguments[:tag] ||= :div
       system_arguments[:classes] = class_names("UnderlineNav-actions", system_arguments[:classes])
-      Primer::BaseComponent.new(**system_arguments) { content }
+
+      Primer::BaseComponent.new(**system_arguments)
     }
 
     # @example Default
-    #   <%= render(Primer::UnderlineNavComponent.new) do |component| %>
-    #     <% component.body do %>
-    #       <%= render(Primer::LinkComponent.new(href: "#url")) { "Item 1" } %>
+    #   <%= render(Primer::UnderlineNavComponent.new(label: "Default")) do |component| %>
+    #     <% component.tab(href: "#", selected: true) { "Item 1" } %>
+    #     <% component.tab(href: "#") { "Item 2" } %>
+    #     <% component.actions do %>
+    #       <%= render(Primer::ButtonComponent.new) { "Button!" } %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # @example With icons and counters
+    #   <%= render(Primer::UnderlineNavComponent.new(label: "With icons and counters")) do |component| %>
+    #     <% component.tab(href: "#", selected: true) do |t| %>
+    #       <% t.icon(icon: :star) %>
+    #       <% t.text { "Item 1" } %>
+    #     <% end %>
+    #     <% component.tab(href: "#") do |t| %>
+    #       <% t.icon(icon: :star) %>
+    #       <% t.text { "Item 2" } %>
+    #       <% t.counter(count: 10) %>
+    #     <% end %>
+    #     <% component.tab(href: "#") do |t| %>
+    #       <% t.text { "Item 3" } %>
+    #       <% t.counter(count: 10) %>
     #     <% end %>
     #     <% component.actions do %>
     #       <%= render(Primer::ButtonComponent.new) { "Button!" } %>
@@ -40,27 +72,93 @@ module Primer
     #   <% end %>
     #
     # @example Align right
-    #   <%= render(Primer::UnderlineNavComponent.new(align: :right)) do |component| %>
-    #     <% component.body do %>
-    #       <%= render(Primer::LinkComponent.new(href: "#url")) { "Item 1" } %>
+    #   <%= render(Primer::UnderlineNavComponent.new(label: "Align right", align: :right)) do |component| %>
+    #     <% component.tab(href: "#", selected: true) do |t| %>
+    #       <% t.text { "Item 1" } %>
+    #     <% end %>
+    #     <% component.tab(href: "#") do |t| %>
+    #       <% t.text { "Item 2" } %>
     #     <% end %>
     #     <% component.actions do %>
     #       <%= render(Primer::ButtonComponent.new) { "Button!" } %>
     #     <% end %>
     #   <% end %>
     #
+    # @example As a list
+    #   <%= render(Primer::UnderlineNavComponent.new(label: "As a list", body_arguments: { tag: :ul })) do |component| %>
+    #     <% component.tab(href: "#", selected: true) do |t| %>
+    #       <% t.text { "Item 1" } %>
+    #     <% end %>
+    #     <% component.tab(href: "#") do |t| %>
+    #       <% t.text { "Item 2" } %>
+    #     <% end %>
+    #     <% component.actions do %>
+    #       <%= render(Primer::ButtonComponent.new) { "Button!" } %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # @example With panels
+    #   <%= render(Primer::UnderlineNavComponent.new(label: "With panels", with_panel: true)) do |component| %>
+    #     <% component.tab(selected: true) do |t| %>
+    #       <% t.text { "Item 1" } %>
+    #       <% t.panel do %>
+    #         Panel 1
+    #       <% end %>
+    #     <% end %>
+    #     <% component.tab do |t| %>
+    #       <% t.text { "Item 2" } %>
+    #       <% t.panel do %>
+    #         Panel 2
+    #       <% end %>
+    #     <% end %>
+    #     <% component.actions do %>
+    #       <%= render(Primer::ButtonComponent.new) { "Button!" } %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # @param label [String] The `aria-label` on top level `<nav>` element.
+    # @param with_panel [Boolean] Whether the TabNav should navigate through pages or panels.
     # @param align [Symbol] <%= one_of(Primer::UnderlineNavComponent::ALIGN_OPTIONS) %> - Defaults to <%= Primer::UnderlineNavComponent::ALIGN_DEFAULT %>
+    # @param body_arguments [Hash] <%= link_to_system_arguments_docs %> for the body wrapper.
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    def initialize(align: ALIGN_DEFAULT, **system_arguments)
+    def initialize(label:, with_panel: false, align: ALIGN_DEFAULT, body_arguments: { tag: BODY_TAG_DEFAULT }, **system_arguments)
+      @with_panel = with_panel
       @align = fetch_or_fallback(ALIGN_OPTIONS, align, ALIGN_DEFAULT)
 
       @system_arguments = system_arguments
-      @system_arguments[:tag] = :nav
+      @system_arguments[:tag] = navigation_tag(with_panel)
       @system_arguments[:classes] = class_names(
         @system_arguments[:classes],
         "UnderlineNav",
         "UnderlineNav--right" => @align == :right
       )
+
+      @body_arguments = body_arguments
+      @body_tag = fetch_or_fallback(BODY_TAG_OPTIONS, body_arguments[:tag]&.to_sym, BODY_TAG_DEFAULT)
+
+      @body_arguments[:tag] = @body_tag
+      @body_arguments[:classes] = class_names(
+        "UnderlineNav-body",
+        @body_arguments[:classes],
+        "list-style-none" => list?
+      )
+
+      if with_panel
+        @body_arguments[:role] = :tablist
+        @body_arguments[:"aria-label"] = label
+      else
+        @system_arguments[:"aria-label"] = label
+      end
+    end
+
+    private
+
+    def list?
+      @body_tag == :ul
+    end
+
+    def body
+      Primer::BaseComponent.new(**@body_arguments)
     end
   end
 end

data/app/lib/primer/classify.rb

@@ -3,12 +3,11 @@
 module Primer
   # :nodoc:
   class Classify
-    MARGIN_DIRECTION_KEYS = %i[mt ml mb mr].freeze
-    SPACING_KEYS = (%i[m my mx p py px pt pl pb pr] + MARGIN_DIRECTION_KEYS).freeze
     DIRECTION_KEY = :direction
     JUSTIFY_CONTENT_KEY = :justify_content
     ALIGN_ITEMS_KEY = :align_items
     DISPLAY_KEY = :display
+    SPACING_KEYS = Primer::Classify::Spacing::KEYS
     RESPONSIVE_KEYS = ([DISPLAY_KEY, DIRECTION_KEY, JUSTIFY_CONTENT_KEY, ALIGN_ITEMS_KEY, :col, :float] + SPACING_KEYS).freeze
     BREAKPOINTS = ["", "-sm", "-md", "-lg", "-xl"].freeze
 
@@ -184,16 +183,10 @@ module Primer
         return if val.nil? || val == ""
 
         if SPACING_KEYS.include?(key)
-          if MARGIN_DIRECTION_KEYS.include?(key)
-            raise ArgumentError, "value of #{key} must be between -6 and 6" if val < -6 || val > 6
-          elsif !((key == :mx || key == :my) && val == :auto)
-            raise ArgumentError, "value of #{key} must be between 0 and 6" if val.negative? || val > 6
-          end
-        end
-
-        if BOOLEAN_MAPPINGS.key?(key)
-          BOOLEAN_MAPPINGS[key][:mappings].map { |m| m[:css_class] if m[:value] == val }.compact.each do |css_class|
-            memo[:classes] << css_class
+          memo[:classes] << Primer::Classify::Spacing.spacing(key, val, breakpoint)
+        elsif BOOLEAN_MAPPINGS.key?(key)
+          BOOLEAN_MAPPINGS[key][:mappings].each do |m|
+            memo[:classes] << m[:css_class] if m[:value] == val && m[:css_class].present?
           end
         elsif key == BG_KEY
           if val.to_s.start_with?("#")
@@ -248,8 +241,6 @@ module Primer
           memo[:classes] << "text-#{val.to_s.dasherize}"
         elsif TYPOGRAPHY_KEYS.include?(key)
           memo[:classes] << "f#{val.to_s.dasherize}"
-        elsif MARGIN_DIRECTION_KEYS.include?(key) && val.negative?
-          memo[:classes] << "#{key.to_s.dasherize}#{breakpoint}-n#{val.abs}"
         elsif key == BOX_SHADOW_KEY
           memo[:classes] << if val == true
                               "color-shadow-small"

data/app/lib/primer/classify/cache.rb

@@ -20,13 +20,23 @@ module Primer
 
         def preload!
           preload(
-            keys: Primer::Classify::MARGIN_DIRECTION_KEYS,
-            values: [-6, -5, -4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6]
+            keys: Primer::Classify::Spacing::MARGIN_DIRECTION_MAPPINGS.keys,
+            values: Primer::Classify::Spacing::MARGIN_DIRECTION_OPTIONS
           )
 
           preload(
-            keys: (Primer::Classify::SPACING_KEYS - Primer::Classify::MARGIN_DIRECTION_KEYS),
-            values: [0, 1, 2, 3, 4, 5, 6]
+            keys: Primer::Classify::Spacing::BASE_MAPPINGS.keys,
+            values: Primer::Classify::Spacing::BASE_OPTIONS
+          )
+
+          preload(
+            keys: Primer::Classify::Spacing::AUTO_MAPPINGS.keys,
+            values: Primer::Classify::Spacing::AUTO_OPTIONS
+          )
+
+          preload(
+            keys: Primer::Classify::Spacing::RESPONSIVE_MAPPINGS.keys,
+            values: Primer::Classify::Spacing::RESPONSIVE_OPTIONS
           )
 
           preload(

data/app/lib/primer/classify/spacing.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Primer
+  class Classify
+    # Handler for PrimerCSS spacing classes.
+    class Spacing
+      BASE_OPTIONS = (0..6).to_a.freeze
+      BASE_MAPPINGS = {
+        my: BASE_OPTIONS,
+        pb: BASE_OPTIONS,
+        pl: BASE_OPTIONS,
+        pr: BASE_OPTIONS,
+        pt: BASE_OPTIONS,
+        px: BASE_OPTIONS,
+        py: BASE_OPTIONS
+      }.freeze
+
+      MARGIN_DIRECTION_OPTIONS = [*(-6..-1), *BASE_OPTIONS].freeze
+      MARGIN_DIRECTION_MAPPINGS = {
+        mb: MARGIN_DIRECTION_OPTIONS,
+        ml: MARGIN_DIRECTION_OPTIONS,
+        mr: MARGIN_DIRECTION_OPTIONS,
+        mt: MARGIN_DIRECTION_OPTIONS
+      }.freeze
+
+      AUTO_OPTIONS = [*BASE_OPTIONS, :auto].freeze
+      AUTO_MAPPINGS = {
+        m: AUTO_OPTIONS,
+        mx: AUTO_OPTIONS
+      }.freeze
+
+      RESPONSIVE_OPTIONS = [*BASE_OPTIONS, :responsive].freeze
+      RESPONSIVE_MAPPINGS = {
+        p: RESPONSIVE_OPTIONS
+      }.freeze
+
+      MAPPINGS = {
+        **BASE_MAPPINGS,
+        **MARGIN_DIRECTION_MAPPINGS,
+        **AUTO_MAPPINGS,
+        **RESPONSIVE_MAPPINGS
+      }.freeze
+      KEYS = MAPPINGS.keys.freeze
+
+      class << self
+        def spacing(key, val, breakpoint)
+          validate(key, val) unless Rails.env.production?
+
+          return "#{key.to_s.dasherize}#{breakpoint}-n#{val.abs}" if val.is_a?(Numeric) && val.negative?
+
+          "#{key.to_s.dasherize}#{breakpoint}-#{val.to_s.dasherize}"
+        end
+
+        private
+
+        def validate(key, val)
+          raise ArgumentError, "#{key} is not a spacing key" unless KEYS.include?(key)
+          raise ArgumentError, "#{val} is not a valid value for :#{key}. Use one of  #{MAPPINGS[key]}" unless MAPPINGS[key].include?(val)
+        end
+      end
+    end
+  end
+end

data/app/lib/primer/tabbed_component_helper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Primer
+  # Helper to share tab validation logic between components.
+  # The component will raise an error if there are 0 or 2+ selected tabs.
+  module TabbedComponentHelper
+    extend ActiveSupport::Concern
+
+    class MultipleSelectedTabsError < StandardError; end
+
+    def before_render
+      validate_single_selected_tab unless Rails.env.production?
+    end
+
+    private
+
+    def navigation_tag(with_panel)
+      with_panel ? :div : :nav
+    end
+
+    def wrapper
+      return yield unless @with_panel
+
+      render Primer::TabContainerComponent.new do
+        yield
+      end
+    end
+
+    def validate_single_selected_tab
+      raise MultipleSelectedTabsError, "only one tab can be selected" if selected_tabs_count > 1
+    end
+
+    def selected_tabs_count
+      @selected_tabs_count ||= tabs.count(&:selected)
+    end
+  end
+end

data/app/lib/primer/view_helper.rb

@@ -12,8 +12,8 @@ module Primer
     }.freeze
 
     HELPERS.each do |name, component|
-      define_method "primer_#{name}" do |**component_args, &block|
-        render component.constantize.new(**component_args), &block
+      define_method "primer_#{name}" do |*args, **kwargs, &block|
+        render component.constantize.new(*args, **kwargs), &block
       end
     end
   end