primer_view_components 0.0.23 → 0.0.28

data/app/components/primer/octicon_component.rb

@@ -3,9 +3,10 @@
 module Primer
   # Renders an [Octicon](https://primer.style/octicons/) with <%= link_to_system_arguments_docs %>.
   class OcticonComponent < Primer::Component
-    view_helper :octicon
+    status :beta
 
-    include Primer::ClassNameHelper
+    include ClassNameHelper
+    include TestSelectorHelper
     include OcticonsHelper
 
     SIZE_DEFAULT = :small
@@ -38,15 +39,11 @@ module Primer
       # 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 = @system_arguments.except(*Primer::Classify::VALID_KEYS, :classes).merge(octicon_helper_options)
+      @system_arguments = add_test_selector(@system_arguments).except(*Primer::Classify::VALID_KEYS, :classes).merge(octicon_helper_options)
     end
 
     def call
       octicon(@icon, { **@system_arguments })
     end
-
-    def self.status
-      Primer::Component::STATUSES[:beta]
-    end
   end
 end

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

@@ -1,10 +1,6 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <%= render body.component do %>
-    <% if heading %>
-      <%= render heading.component do %>
-        <%= heading.content %>
-      <% end %>
-    <% end %>
-    <%= body.content %>
+  <%= render(body_component) do %>
+    <%= heading %>
+    <%= body %>
   <% end %>
 <% end %>

data/app/components/primer/popover_component.rb

@@ -5,37 +5,84 @@ module Primer
   #
   # 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
-    include ViewComponent::Slotable
+    include ViewComponent::SlotableV2
+    status :beta
 
-    with_slot :heading, class_name: "Heading"
-    with_slot :body, class_name: "Body"
+    CARET_DEFAULT = :top
+    CARET_MAPPINGS = {
+      CARET_DEFAULT => "",
+      :bottom => "Popover-message--bottom",
+      :bottom_right => "Popover-message--bottom-right",
+      :bottom_left => "Popover-message--bottom-left",
+      :left => "Popover-message--left",
+      :left_bottom => "Popover-message--left-bottom",
+      :left_top => "Popover-message--left-top",
+      :right => "Popover-message--right",
+      :right_bottom => "Popover-message--right-bottom",
+      :right_top => "Popover-message--right-top",
+      :top_left => "Popover-message--top-left",
+      :top_right => "Popover-message--top-right"
+    }.freeze
+
+    # The heading
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_one :heading, lambda { |**system_arguments|
+      system_arguments[:mb] ||= 2
+      system_arguments[:tag] ||= :h4
+
+      Primer::HeadingComponent.new(**system_arguments)
+    }
+
+    # The body
+    #
+    # @param caret [Symbol] <%= one_of(Primer::PopoverComponent::CARET_MAPPINGS.keys) %>
+    # @param large [Boolean] Whether to use the large version of the component.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_one :body, lambda { |caret: CARET_DEFAULT, large: false, **system_arguments, &block|
+      system_arguments[:classes] = class_names(
+        system_arguments[:classes],
+        "Popover-message Box",
+        CARET_MAPPINGS[fetch_or_fallback(CARET_MAPPINGS.keys, caret, CARET_DEFAULT)],
+        "Popover-message--large" => large
+      )
+      system_arguments[:p] ||= 4
+      system_arguments[:mt] ||= 2
+      system_arguments[:mx] ||= :auto
+      system_arguments[:text_align] ||= :left
+      system_arguments[:box_shadow] ||= :large
+
+      # This is a hack to allow the parent to set the slot's content
+      @body_arguments = system_arguments
+      block&.call
+    }
 
     # @example Default
     #   <%= render Primer::PopoverComponent.new do |component| %>
-    #     <% component.slot(:heading) do %>
+    #     <% component.heading do %>
     #       Activity feed
     #     <% end %>
-    #     <% component.slot(:body) do %>
+    #     <% component.body do %>
     #       This is the Popover body.
     #     <% end %>
     #   <% end %>
     #
     # @example Large
     #   <%= render Primer::PopoverComponent.new do |component| %>
-    #     <% component.slot(:heading) do %>
+    #     <% component.heading do %>
     #       Activity feed
     #     <% end %>
-    #     <% component.slot(:body, large: true) do %>
+    #     <% component.body(large: true) do %>
     #       This is the large Popover body.
     #     <% end %>
     #   <% end %>
     #
     # @example Caret position
     #   <%= render Primer::PopoverComponent.new do |component| %>
-    #     <% component.slot(:heading) do %>
+    #     <% component.heading do %>
     #       Activity feed
     #     <% end %>
-    #     <% component.slot(:body, caret: :left) do %>
+    #     <% component.body(caret: :left) do %>
     #       This is the large Popover body.
     #     <% end %>
     #   <% end %>
@@ -57,59 +104,8 @@ module Primer
       body.present?
     end
 
-    # :nodoc:
-    class Heading < Primer::Slot
-      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(**system_arguments)
-        @system_arguments = system_arguments
-        @system_arguments[:mb] ||= 2
-        @system_arguments[:tag] ||= :h4
-      end
-
-      def component
-        Primer::HeadingComponent.new(**@system_arguments)
-      end
-    end
-
-    # :nodoc:
-    class Body < Slot
-      CARET_DEFAULT = :top
-      CARET_MAPPINGS = {
-        CARET_DEFAULT => "",
-        :bottom => "Popover-message--bottom",
-        :bottom_right => "Popover-message--bottom-right",
-        :bottom_left => "Popover-message--bottom-left",
-        :left => "Popover-message--left",
-        :left_bottom => "Popover-message--left-bottom",
-        :left_top => "Popover-message--left-top",
-        :right => "Popover-message--right",
-        :right_bottom => "Popover-message--right-bottom",
-        :right_top => "Popover-message--right-top",
-        :top_left => "Popover-message--top-left",
-        :top_right => "Popover-message--top-right"
-      }.freeze
-
-      # @param caret [Symbol] <%= one_of(Primer::PopoverComponent::Body::CARET_MAPPINGS.keys) %>
-      # @param large [Boolean] Whether to use the large version of the component.
-      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(caret: CARET_DEFAULT, large: false, **system_arguments)
-        @system_arguments = system_arguments
-        @system_arguments[:classes] = class_names(
-          system_arguments[:classes],
-          "Popover-message Box",
-          CARET_MAPPINGS[fetch_or_fallback(CARET_MAPPINGS.keys, caret, CARET_DEFAULT)],
-          "Popover-message--large" => large
-        )
-        @system_arguments[:p] ||= 4
-        @system_arguments[:mt] ||= 2
-        @system_arguments[:mx] ||= :auto
-        @system_arguments[:text_align] ||= :left
-        @system_arguments[:box_shadow] ||= :large
-      end
-
-      def component
-        Primer::BoxComponent.new(**@system_arguments)
-      end
+    def body_component
+      Primer::BoxComponent.new(**@body_arguments)
     end
   end
 end

data/app/components/primer/primer.d.ts

@@ -0,0 +1,3 @@
+import './auto_complete_component';
+import './tab_container_component';
+import './time_ago_component';

data/app/components/primer/primer.js

@@ -1 +1,3 @@
+import './auto_complete_component';
 import './tab_container_component';
+import './time_ago_component';

data/app/components/primer/primer.ts

@@ -1 +1,3 @@
+import './auto_complete_component'
 import './tab_container_component'
+import './time_ago_component'

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

@@ -1,5 +1,5 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
   <% items.each do |item| %>
-    <%= render Primer::BaseComponent.new(**item.system_arguments) %>
+    <%= item %>
   <% end %>
 <% end %>

data/app/components/primer/progress_bar_component.rb

@@ -3,9 +3,25 @@
 module Primer
   # Use ProgressBar to visualize task completion.
   class ProgressBarComponent < Primer::Component
-    include ViewComponent::Slotable
+    include ViewComponent::SlotableV2
+    status :beta
 
-    with_slot :item, collection: true, class_name: "Item"
+    # Use the Item slot to add an item to the progress bas
+    #
+    # @param percentage [Integer] The percent complete
+    # @param bg [Symbol] The background color
+    # @param kwargs [Hash] The same arguments as <%= link_to_system_arguments_docs %>.
+    renders_many :items, lambda { |percentage: 0, bg: :success_inverse, **system_arguments|
+      percentage = percentage
+      system_arguments = system_arguments
+
+      system_arguments[:tag] = :span
+      system_arguments[:bg] = bg
+      system_arguments[:style] = join_style_arguments(system_arguments[:style], "width: #{percentage}%;")
+      system_arguments[:classes] = class_names("Progress-item", system_arguments[:classes])
+
+      Primer::BaseComponent.new(**system_arguments)
+    }
 
     SIZE_DEFAULT = :default
 
@@ -18,24 +34,24 @@ module Primer
     SIZE_OPTIONS = SIZE_MAPPINGS.keys
     # @example Default
     #   <%= render(Primer::ProgressBarComponent.new) do |component| %>
-    #     <% component.slot(:item, percentage: 25) %>
+    #     <% component.item(percentage: 25) %>
     #   <% end %>
     #
     # @example Small
     #   <%= render(Primer::ProgressBarComponent.new(size: :small)) do |component| %>
-    #     <% component.slot(:item, bg: :blue_4, percentage: 50) %>
+    #     <% component.item(bg: :info_inverse, percentage: 50) %>
     #   <% end %>
     #
     # @example Large
     #   <%= render(Primer::ProgressBarComponent.new(size: :large)) do |component| %>
-    #     <% component.slot(:item, bg: :red_4, percentage: 75) %>
+    #     <% component.item(bg: :danger_inverse, percentage: 75) %>
     #   <% end %>
     #
     # @example Multiple items
     #   <%= render(Primer::ProgressBarComponent.new) do |component| %>
-    #     <% component.slot(:item, percentage: 10) %>
-    #     <% component.slot(:item, bg: :blue_4, percentage: 20) %>
-    #     <% component.slot(:item, bg: :red_4, percentage: 30) %>
+    #     <% component.item(percentage: 10) %>
+    #     <% component.item(bg: :info_inverse, percentage: 20) %>
+    #     <% component.item(bg: :danger_inverse, percentage: 30) %>
     #   <% end %>
     #
     # @param size [Symbol] <%= one_of(Primer::ProgressBarComponent::SIZE_OPTIONS) %> Increases height.
@@ -53,24 +69,5 @@ module Primer
     def render?
       items.any?
     end
-
-    # :nodoc:
-    class Item < Primer::Slot
-      attr_reader :system_arguments
-
-      # @param percentage [Integer] Percentage completion of item.
-      # @param bg [Symbol] Color of item.
-      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(percentage: 0, bg: :green, **system_arguments)
-        @percentage = percentage
-        @system_arguments = system_arguments
-
-        @system_arguments[:tag] = :span
-        @system_arguments[:bg] = bg
-        @system_arguments[:style] =
-          join_style_arguments(@system_arguments[:style], "width: #{@percentage}%;")
-        @system_arguments[:classes] = class_names("Progress-item", @system_arguments[:classes])
-      end
-    end
   end
 end

data/app/components/primer/spinner_component.rb

@@ -3,6 +3,8 @@
 module Primer
   # Use Primer::SpinnerComponent to let users know that content is being loaded.
   class SpinnerComponent < Primer::Component
+    status :beta
+
     DEFAULT_SIZE = :medium
     SIZE_MAPPINGS = {
       :small => 16,
@@ -34,9 +36,5 @@ module Primer
       @system_arguments[:viewBox] = "0 0 16 16"
       @system_arguments[:fill] = :none
     end
-
-    def self.status
-      Primer::Component::STATUSES[:beta]
-    end
   end
 end

data/app/components/primer/state_component.rb

@@ -3,6 +3,8 @@
 module Primer
   # Component for rendering the status of an item.
   class StateComponent < Primer::Component
+    status :beta
+
     COLOR_DEFAULT = :default
     NEW_COLOR_MAPPINGS = {
       open: "State--open",
@@ -68,9 +70,5 @@ module Primer
     def call
       render(Primer::BaseComponent.new(**@system_arguments)) { content }
     end
-
-    def self.status
-      Primer::Component::STATUSES[:beta]
-    end
   end
 end

data/app/components/primer/subhead_component.rb

@@ -3,6 +3,8 @@
 module Primer
   # Use the Subhead component for page headings.
   class SubheadComponent < Primer::Component
+    status :beta
+
     include ViewComponent::SlotableV2
 
     # The heading

data/app/components/primer/tab_container_component.d.ts

@@ -0,0 +1 @@
+import '@github/tab-container-element';

data/app/components/primer/text_component.rb

@@ -3,9 +3,11 @@
 module Primer
   # The Text component is a wrapper component that will apply typography styles to the text inside.
   class TextComponent < Primer::Component
+    status :beta
+
     # @example Default
     #   <%= render(Primer::TextComponent.new(tag: :p, font_weight: :bold)) { "Bold Text" } %>
-    #   <%= render(Primer::TextComponent.new(tag: :p, color: :red_5)) { "Red Text" } %>
+    #   <%= render(Primer::TextComponent.new(tag: :p, color: :text_danger)) { "Danger Text" } %>
     #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(**system_arguments)

data/app/components/primer/time_ago_component.d.ts

@@ -0,0 +1 @@
+import '@github/time-elements';

data/app/components/primer/time_ago_component.js

@@ -0,0 +1 @@
+import '@github/time-elements';

data/app/components/primer/time_ago_component.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use Primer::TimeAgoComponent to display a time relative to how long ago it was. This component requires JavaScript.
+  class TimeAgoComponent < Primer::Component
+    #
+    # @example Default
+    #   <%= render(Primer::TimeAgoComponent.new(time: Time.at(628232400))) %>
+    #
+    # @param time [Time] The time to be formatted
+    # @param micro [Boolean] If true then the text will be formatted in "micro" mode, using as few characters as possible
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(time:, micro: false, **system_arguments)
+      @system_arguments = system_arguments
+      @system_arguments[:datetime] = time.utc.iso8601
+      @system_arguments[:classes] = class_names("no-wrap", @system_arguments[:classes])
+      @system_arguments[:tag] = "time-ago"
+      @system_arguments[:format] = "micro" if micro
+      @time = time
+      @micro = micro
+    end
+
+    def call
+      render(Primer::BaseComponent.new(**@system_arguments)) { time_in_words }
+    end
+
+    private
+
+    def time_in_words
+      return @time.in_time_zone.strftime("%b %-d, %Y") unless @micro
+
+      seconds_ago = Time.current - @time
+
+      if seconds_ago < 1.minute
+        "1m"
+      elsif seconds_ago >= 1.minute && seconds_ago < 1.hour
+        "#{(seconds_ago / 60).floor}m"
+      elsif seconds_ago >= 1.hour && seconds_ago < 1.day
+        "#{(seconds_ago / 60 / 60).floor}h"
+      elsif seconds_ago >= 1.day && seconds_ago < 1.year
+        "#{(seconds_ago / 60 / 60 / 24).floor}d"
+      elsif seconds_ago >= 1.year
+        "#{(seconds_ago / 60 / 60 / 24 / 365).floor}y"
+      end
+    end
+  end
+end

data/app/components/primer/time_ago_component.ts

@@ -0,0 +1 @@
+import '@github/time-elements'

data/app/components/primer/timeline_item_component.rb

@@ -4,6 +4,7 @@ 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.
     #
@@ -40,7 +41,7 @@ module Primer
     #   <div style="padding-left: 60px">
     #     <%= render(Primer::TimelineItemComponent.new) do |component| %>
     #       <% component.avatar(src: "https://github.com/github.png", alt: "github") %>
-    #       <% component.badge(bg: :green, color: :white, icon: :check) %>
+    #       <% component.badge(bg: :success_inverse, color: :text_white, icon: :check) %>
     #       <% component.body { "Success!" } %>
     #     <% end %>
     #   </div>