primer_view_components 0.0.15 → 0.0.20

data/app/components/primer/box_component.rb

@@ -3,6 +3,12 @@
 module Primer
   # A basic wrapper component for most layout related needs.
   class BoxComponent < Primer::Component
+    # @example auto|Default
+    #   <%= render(Primer::BoxComponent.new) { "Your content here" } %>
+    #
+    # @example auto|Color and padding
+    #   <%= render(Primer::BoxComponent.new(bg: :gray, p: 3)) { "Hello world" } %>
+    #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(**system_arguments)
       @system_arguments = system_arguments
@@ -12,5 +18,9 @@ module Primer
     def call
       render(Primer::BaseComponent.new(**@system_arguments)) { content }
     end
+
+    def self.status
+      Primer::Component::STATUSES[:stable]
+    end
   end
 end

data/app/components/primer/breadcrumb_component.rb

@@ -7,7 +7,7 @@ module Primer
 
     with_slot :item, collection: true, class_name: "BreadcrumbItem"
 
-    # @example 40|Basic
+    # @example auto|Basic
     #   <%= render(Primer::BreadcrumbComponent.new) do |component| %>
     #     <% component.slot(:item, href: "/") do %>Home<% end %>
     #     <% component.slot(:item, href: "/about") do %>About<% end %>
@@ -33,7 +33,8 @@ module Primer
       # @param selected [Boolean] Whether or not the item is selected and not rendered as a link.
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
       def initialize(href: nil, selected: false, **system_arguments)
-        @href, @system_arguments = href, system_arguments
+        @href = href
+        @system_arguments = system_arguments
 
         @href = nil if selected
         @system_arguments[:tag] = :li

data/app/components/primer/button_component.rb

@@ -16,7 +16,7 @@ module Primer
     VARIANT_MAPPINGS = {
       :small => "btn-sm",
       DEFAULT_VARIANT => "",
-      :large => "btn-large",
+      :large => "btn-large"
     }.freeze
     VARIANT_OPTIONS = VARIANT_MAPPINGS.keys
 
@@ -26,13 +26,13 @@ module Primer
     DEFAULT_TYPE = :button
     TYPE_OPTIONS = [DEFAULT_TYPE, :reset, :submit].freeze
 
-    # @example 50|Button types
+    # @example auto|Button types
     #   <%= render(Primer::ButtonComponent.new) { "Default" } %>
     #   <%= render(Primer::ButtonComponent.new(button_type: :primary)) { "Primary" } %>
     #   <%= render(Primer::ButtonComponent.new(button_type: :danger)) { "Danger" } %>
     #   <%= render(Primer::ButtonComponent.new(button_type: :outline)) { "Outline" } %>
     #
-    # @example 50|Variants
+    # @example auto|Variants
     #   <%= render(Primer::ButtonComponent.new(variant: :small)) { "Small" } %>
     #   <%= render(Primer::ButtonComponent.new(variant: :medium)) { "Medium" } %>
     #   <%= render(Primer::ButtonComponent.new(variant: :large)) { "Large" } %>

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

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

data/app/components/primer/button_group_component.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use ButtonGroupComponent to render a series of buttons.
+  class ButtonGroupComponent < Primer::Component
+    include ViewComponent::SlotableV2
+
+    # Required list of buttons to be rendered.
+    #
+    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::ButtonComponent) %>.
+    renders_many :buttons, ->(**kwargs) { Primer::ButtonComponent.new(group_item: true, **kwargs) }
+
+    # @example auto|Default
+    #   <%= render(Primer::ButtonGroupComponent.new) do |component|
+    #     component.button { "Default" }
+    #     component.button(button_type: :primary) { "Primary" }
+    #     component.button(button_type: :danger) { "Danger" }
+    #     component.button(button_type: :outline) { "Outline" }
+    #     component.button(classes: "my-class") { "Custom class" }
+    #   end %>
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(**system_arguments)
+      @system_arguments = system_arguments
+      @system_arguments[:tag] ||= :div
+
+      @system_arguments[:classes] = class_names(
+        "BtnGroup",
+        system_arguments[:classes]
+      )
+    end
+
+    def render?
+      buttons.any?
+    end
+  end
+end

data/app/components/primer/button_marketing_component.rb

@@ -0,0 +1,73 @@
+# 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.
+  class ButtonMarketingComponent < Primer::Component
+    DEFAULT_BUTTON_TYPE = :default
+    BUTTON_TYPE_MAPPINGS = {
+      DEFAULT_BUTTON_TYPE => "",
+      :primary => "btn-primary-mktg",
+      :outline => "btn-outline-mktg",
+      :transparent => "btn-transparent"
+    }.freeze
+    BUTTON_TYPE_OPTIONS = BUTTON_TYPE_MAPPINGS.keys
+
+    DEFAULT_VARIANT = :default
+    VARIANT_MAPPINGS = {
+      DEFAULT_VARIANT => "",
+      :large => "btn-large-mktg"
+    }.freeze
+    VARIANT_OPTIONS = VARIANT_MAPPINGS.keys
+
+    DEFAULT_TAG = :button
+    TAG_OPTIONS = [DEFAULT_TAG, :a].freeze
+
+    DEFAULT_TYPE = :button
+    TYPE_OPTIONS = [DEFAULT_TYPE, :submit].freeze
+
+    # @example auto|Button types
+    #   <%= render(Primer::ButtonMarketingComponent.new(mr: 2)) { "Default" } %>
+    #   <%= render(Primer::ButtonMarketingComponent.new(button_type: :primary, mr: 2)) { "Primary" } %>
+    #   <%= render(Primer::ButtonMarketingComponent.new(button_type: :outline)) { "Outline" } %>
+    #   <div class="bg-gray-dark">
+    #     <%= render(Primer::ButtonMarketingComponent.new(button_type: :transparent)) { "Transparent" } %>
+    #   </div>
+    #
+    # @example auto|Sizes
+    #   <%= render(Primer::ButtonMarketingComponent.new(mr: 2)) { "Default" } %>
+    #   <%= render(Primer::ButtonMarketingComponent.new(variant: :large)) { "Large" } %>
+    #
+    # @param button_type [Symbol] <%= one_of(Primer::ButtonMarketingComponent::BUTTON_TYPE_OPTIONS) %>
+    # @param variant [Symbol] <%= one_of(Primer::ButtonMarketingComponent::VARIANT_OPTIONS) %>
+    # @param tag [Symbol] <%= one_of(Primer::ButtonMarketingComponent::TAG_OPTIONS) %>
+    # @param type [Symbol] <%= one_of(Primer::ButtonMarketingComponent::TYPE_OPTIONS) %>
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(
+      button_type: DEFAULT_BUTTON_TYPE,
+      variant: DEFAULT_VARIANT,
+      tag: DEFAULT_TAG,
+      type: DEFAULT_TYPE,
+      **system_arguments
+    )
+      @system_arguments = system_arguments
+      @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
+
+      if @system_arguments[:tag] == :a
+        @system_arguments[:role] = :button
+      else
+        @system_arguments[:type] = fetch_or_fallback(TYPE_OPTIONS, type, DEFAULT_TYPE)
+      end
+
+      @system_arguments[:classes] = class_names(
+        "btn-mktg",
+        BUTTON_TYPE_MAPPINGS[fetch_or_fallback(BUTTON_TYPE_OPTIONS, button_type, DEFAULT_BUTTON_TYPE)],
+        VARIANT_MAPPINGS[fetch_or_fallback(VARIANT_OPTIONS, variant, DEFAULT_VARIANT)],
+        system_arguments[:classes]
+      )
+    end
+
+    def call
+      render(Primer::BaseComponent.new(**@system_arguments)) { content }
+    end
+  end
+end

data/app/components/primer/component.rb

@@ -6,5 +6,18 @@ module Primer
     include ClassNameHelper
     include FetchOrFallbackHelper
     include OcticonsHelper
+    include JoinStyleArgumentsHelper
+
+    # sourced from https://primer.style/doctocat/usage/front-matter#status
+    STATUSES = {
+      alpha: :alpha,
+      beta: :beta,
+      stable: :stable,
+      deprecated: :deprecated
+    }.freeze
+
+    def self.status
+      STATUSES[:alpha]
+    end
   end
 end

data/app/components/primer/counter_component.rb

@@ -7,11 +7,11 @@ module Primer
     SCHEME_MAPPINGS = {
       DEFAULT_SCHEME => "Counter",
       :gray => "Counter Counter--gray",
-      :light_gray => "Counter Counter--gray-light",
+      :light_gray => "Counter Counter--gray-light"
     }.freeze
 
     #
-    # @example 34|Default
+    # @example auto|Default
     #   <%= render(Primer::CounterComponent.new(count: 25)) %>
     #
     # @param count [Integer, Float::INFINITY, nil] The number to be displayed (e.x. # of issues, pull requests)
@@ -30,7 +30,12 @@ module Primer
       round: false,
       **system_arguments
     )
-      @count, @limit, @hide_if_zero, @text, @round, @system_arguments = count, limit, hide_if_zero, text, round, system_arguments
+      @count = count
+      @limit = limit
+      @hide_if_zero = hide_if_zero
+      @text = text
+      @round = round
+      @system_arguments = system_arguments
 
       @has_limit = !@limit.nil?
       @system_arguments[:title] = title
@@ -39,15 +44,17 @@ module Primer
         @system_arguments[:classes],
         SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_MAPPINGS.keys, scheme, DEFAULT_SCHEME)]
       )
-      if count == 0 && hide_if_zero
-        @system_arguments[:hidden] = true
-      end
+      @system_arguments[:hidden] = true if count == 0 && hide_if_zero # rubocop:disable Style/NumericPredicate
     end
 
     def call
       render(Primer::BaseComponent.new(**@system_arguments)) { value }
     end
 
+    def self.status
+      Primer::Component::STATUSES[:beta]
+    end
+
     private
 
     def title
@@ -60,7 +67,7 @@ module Primer
       else
         count = @count.to_i
         str = number_with_delimiter(@has_limit ? [count, @limit].min : count)
-        str += "+" if (@has_limit && count > @limit)
+        str += "+" if @has_limit && count > @limit
         str
       end
     end
@@ -76,14 +83,14 @@ module Primer
         if @round
           count = @has_limit ? [@count.to_i, @limit].min : @count.to_i
           precision = count.between?(100_000, 999_999) ? 0 : 1
-          units = {thousand: "k", million: "m", billion: "b"}
+          units = { thousand: "k", million: "m", billion: "b" }
           str = number_to_human(count, precision: precision, significant: false, units: units, format: "%n%u")
         else
           @count = @count.to_i
           str = number_with_delimiter(@has_limit ? [@count, @limit].min : @count)
         end
 
-        str += "+" if (@has_limit && @count.to_i > @limit)
+        str += "+" if @has_limit && @count.to_i > @limit
         str
       end
     end

data/app/components/primer/details_component.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
 module Primer
-  #
-  # overlay - options are `none`, `default` and `dark`. Dictates the type of overlay to render with.
-  # button - options are `default` and `reset`. default will make the target a default primer ``.btn`
-  #          reset will remove all styles from the <summary> element.
-  #
+  # Use DetailsComponent to reveal content after clicking a button.
   class DetailsComponent < Primer::Component
     include ViewComponent::Slotable
 
@@ -13,12 +9,15 @@ module Primer
     OVERLAY_MAPPINGS = {
       NO_OVERLAY => "",
       :default => "details-overlay",
-      :dark => "details-overlay details-overlay-dark",
+      :dark => "details-overlay details-overlay-dark"
     }.freeze
 
     with_slot :body, class_name: "Body"
     with_slot :summary, class_name: "Summary"
 
+    # @param overlay [Symbol] Dictates the type of overlay to render with. <%= one_of(Primer::DetailsComponent::OVERLAY_MAPPINGS.keys) %>
+    # @param reset [Boolean] Defatuls to false. If set to true, it will remove the default caret and remove style from the summary element
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(overlay: NO_OVERLAY, reset: false, **system_arguments)
       @system_arguments = system_arguments
       @system_arguments[:tag] = :details
@@ -33,7 +32,10 @@ module Primer
       summary.present? && body.present?
     end
 
+    # Use the Summary slot as a trigger to reveal the content.
     class Summary < Primer::Slot
+      # @param button [Boolean] Whether to render the Summary as a button or not.
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
       def initialize(button: true, **system_arguments)
         @button = button
 
@@ -49,7 +51,9 @@ module Primer
       end
     end
 
+    # Use the Body slot as the main content to be shown when triggered by the Summary.
     class Body < Primer::Slot
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
       def initialize(**system_arguments)
         @system_arguments = system_arguments
         @system_arguments[:tag] ||= :div

data/app/components/primer/dropdown/menu_component.html.erb

@@ -0,0 +1,12 @@
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <% if @header.present? %>
+    <div class="dropdown-header">
+      <%= @header %>
+    </div>
+  <% end %>
+  <ul>
+    <% items.each do |item| %>
+      <%= item %>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Primer
+  module Dropdown
+    # This component is part of `Primer::DropdownComponent` and should not be
+    # used as a standalone component.
+    class MenuComponent < Primer::Component
+      include ViewComponent::SlotableV2
+
+      SCHEME_DEFAULT = :default
+      SCHEME_MAPPINGS = {
+        SCHEME_DEFAULT => "",
+        :dark => "dropdown-menu-dark"
+      }.freeze
+
+      DIRECTION_DEFAULT = :se
+      DIRECTION_OPTIONS = [DIRECTION_DEFAULT, :sw, :w, :e, :ne, :s].freeze
+
+      renders_many :items, lambda { |divider: false, **system_arguments|
+        system_arguments[:tag] = :li
+        system_arguments[:role] = :none if divider
+        system_arguments[:classes] = class_names(
+          system_arguments[:classes],
+          "dropdown-item" => !divider,
+          "dropdown-divider" => divider
+        )
+
+        Primer::BaseComponent.new(**system_arguments)
+      }
+
+      def initialize(direction: DIRECTION_DEFAULT, scheme: SCHEME_DEFAULT, header: nil, **system_arguments)
+        @header = header
+        @direction = direction
+        @system_arguments = system_arguments
+
+        @system_arguments[:tag] = "details-menu"
+        @system_arguments[:role] = "menu"
+
+        @system_arguments[:classes] = class_names(
+          @system_arguments[:classes],
+          "dropdown-menu",
+          "dropdown-menu-#{fetch_or_fallback(DIRECTION_OPTIONS, direction, DIRECTION_DEFAULT)}",
+          SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_MAPPINGS.keys, scheme, SCHEME_DEFAULT)]
+        )
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+<%= render(Primer::DetailsComponent.new(**@system_arguments)) do |c| %>
+  <% c.slot(:summary, classes: @summary_classes) do %>
+    <%= button %>
+  <% end %>
+
+  <% c.slot(:body) do %>
+    <%= menu %>
+  <% end %>
+<% end %>

data/app/components/primer/dropdown_component.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "dropdown/menu_component"
+
+module Primer
+  # Dropdowns are lightweight context menus 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
+    include ViewComponent::SlotableV2
+
+    # Required trigger for the dropdown. Only accepts a content.
+    # Its classes can be customized by the `summary_classes` param in the parent component
+    renders_one :button
+
+    # Required context menu for the dropdown
+    #
+    # @param direction [Symbol] <%= one_of(Primer::Dropdown::MenuComponent::DIRECTION_OPTIONS) %>
+    # @param scheme [Symbol] Pass :dark for dark mode theming
+    # @param header [String] Optional string to display as the header
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_one :menu, Primer::Dropdown::MenuComponent
+
+    # @example 210|Default
+    #   <div style="margin-bottom: 150px">
+    #     <%= render(Primer::DropdownComponent.new) do |c| %>
+    #       <% c.button do %>
+    #         Dropdown
+    #       <% end %>
+    #
+    #       <%= c.menu(header: "Options") do |menu|
+    #         menu.item { "Item 1" }
+    #         menu.item { "Item 2" }
+    #         menu.item(divider: true)
+    #         menu.item { "Item 3" }
+    #         menu.item { "Item 4" }
+    #       end %>
+    #     <% end %>
+    #   </div>
+    #
+    # @example 210|With Direction
+    #   <div style="margin-bottom: 150px" class="d-flex flex-justify-center">
+    #     <%= render(Primer::DropdownComponent.new) do |c| %>
+    #       <% c.button do %>
+    #         Dropdown
+    #       <% end %>
+    #
+    #       <%= c.menu(header: "Options", direction: :s) do |menu|
+    #         menu.item { "Item 1" }
+    #         menu.item { "Item 2" }
+    #         menu.item(divider: true)
+    #         menu.item { "Item 3" }
+    #         menu.item { "Item 4" }
+    #       end %>
+    #     <% end %>
+    #   </div>
+    #
+    # @param overlay [Symbol] <%= one_of(Primer::DetailsComponent::OVERLAY_MAPPINGS.keys) %>
+    # @param reset [Boolean] Whether to hide the default caret on the button
+    # @param summary_classes [String] Custom classes to add to the button
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(overlay: :default, reset: true, summary_classes: "", **system_arguments)
+      @system_arguments = system_arguments
+      @system_arguments[:overlay] = overlay
+      @system_arguments[:reset] = reset
+      @system_arguments[:position] = :relative
+      @system_arguments[:classes] = class_names(
+        @system_arguments[:classes],
+        "dropdown"
+      )
+      @summary_classes = summary_classes
+    end
+
+    def render?
+      button.present? && menu.present?
+    end
+  end
+end