primer_view_components 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5a191f5ef0c2e50f095bce5d68943ebdc38a28d0edd66334152e876045d9cd
-  data.tar.gz: 8a103a45a9fed84736298a7b75c45b5f2bff3e78817fd4b02100853dbdf9003e
+  metadata.gz: 2123d6cd3a227f0cf3df93cc601098dc6e6b0b59ba98bbc589ccdd6a4c8b0b4f
+  data.tar.gz: b8b5075b18d79f10a385bb51b6f2d17d324a10fb3c5c5c961e841f96713a8c59
 SHA512:
-  metadata.gz: 467aa20851a1b48cb605984b87a76f0297e5eddd32cee077a8f3cc7a06639829bf6f4dbf79fa81c4aa18f3b6b9cf697867cc8b347a9547d408a7c2aefddd3886
-  data.tar.gz: 9ad2bd67f630a6e734d6b08da43cad5b94482d0ff93085e65f8e8a4ffcf36e150bc7e5ec3beaa542b54a7f9949ff6411da8c6a3db0df460c4e430b0471a03fda
+  metadata.gz: b5ce375e1b8fa9d95cd784ea19565a6bfeb1024db7fdc5e010995f2a7085f5b03cfa163979c7b33648eacfd986b4339b1ca1bdba06e5ba581b8b20a006935d62
+  data.tar.gz: 0d6124a56d36eb09075d4be8bc50b8d1e061c2e9137c030733f6b875488f3f15e0939dd5692116e7f2d29cc7ac81ed6adc5f27cdb442e57ad44b8d456e5c60cc

data/CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## main
 
+## 0.0.19
+
+* Add support for functional colors to `color` system argument.
+
+    *Jake Shorty
+
+* Add `AvatarStack`, `Dropdown`, `Markdown` and `Menu` components.
+
+    *Manuel Puyol*
+
+* Deprecate `DropdownMenuComponent`.
+
+    *Manuel Puyol*
+
+* Fix `Avatar` bug when used with links.
+
+    *Manuel Puyol*
+
+* Add cache for common Primer values.
+
+    *Blake Williams*
+
+* Add support for `octicons_helper` v12.
+
+    *Cole Bemis*
+
+* Add support for `border: true` to apply the `border` class.
+
+    *Simon Taranto*
+
+* Promote `Avatar`, `Link`, and `Counter` components to beta.
+
+    *Simon Taranto*
+
+* **Breaking change**: Drop support for Ruby 2.4.
+
+    *Simon Taranto*
+
 ## 0.0.18
 
 * Add `border_radius` system argument.

data/app/components/primer/avatar_component.rb

@@ -7,15 +7,23 @@ module Primer
   class AvatarComponent < Primer::Component
     SMALL_THRESHOLD = 24
 
-    #
-    # @example 34|Default
+    # @example auto|Default
     #   <%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser")) %>
     #
+    # @example auto|Square
+    #   <%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", square: true)) %>
+    #
+    # @example auto|Link
+    #   <%= render(Primer::AvatarComponent.new(href: "#", src: "http://placekitten.com/200/200", alt: "@kittenuser")) %>
+    #
     # @param src [String] The source url of the avatar image
     # @param alt [String] Passed through to alt on img tag
     # @param size [Integer] Adds the avatar-small class if less than 24
     # @param square [Boolean] Used to create a square avatar.
-    def initialize(src:, alt:, size: 20, square: false, **system_arguments)
+    # @param href [String] The URL to link to. If used, component will be wrapped by an `<a>` tag
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(src:, alt:, size: 20, square: false, href: nil, **system_arguments)
+      @href = href
       @system_arguments = system_arguments
       @system_arguments[:tag] = :img
       @system_arguments[:src] = src
@@ -25,15 +33,25 @@ module Primer
       @system_arguments[:width] = size
 
       @system_arguments[:classes] = class_names(
-        "avatar",
         system_arguments[:classes],
+        "avatar" => !href,
         "avatar--small" => size < SMALL_THRESHOLD,
-        "CircleBadge" => !square
+        "circle" => !square
       )
     end
 
     def call
-      render(Primer::BaseComponent.new(**@system_arguments)) { content }
+      if @href
+        render(Primer::LinkComponent.new(href: @href, classes: "avatar")) do
+          render(Primer::BaseComponent.new(**@system_arguments)) { content }
+        end
+      else
+        render(Primer::BaseComponent.new(**@system_arguments)) { content }
+      end
+    end
+
+    def self.status
+      Primer::Component::STATUSES[:beta]
     end
   end
 end

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

@@ -0,0 +1,10 @@
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <%= render body_component do %>
+    <% avatars.each_with_index do |avatar, i| %>
+      <% if i == 2 %>
+        <div class="avatar avatar-more"></div>
+      <% end %>
+      <%= avatar %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/primer/avatar_stack_component.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use AvatarStack to stack multiple avatars together.
+  class AvatarStackComponent < Primer::Component
+    include ViewComponent::SlotableV2
+
+    ALIGN_DEFAULT = :left
+    ALIGN_OPTIONS = [ALIGN_DEFAULT, :right].freeze
+
+    # Required list of stacked avatars.
+    #
+    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::AvatarComponent) %>.
+    renders_many :avatars, Primer::AvatarComponent
+
+    # @example auto|Default
+    #   <%= render(Primer::AvatarStackComponent.new) do |c| %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #   <% end  %>
+    #
+    # @example auto|Align right
+    #   <%= render(Primer::AvatarStackComponent.new(align: :right)) do |c| %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #   <% end  %>
+    #
+    # @example auto|With tooltip
+    #   <%= render(Primer::AvatarStackComponent.new(tooltipped: true, body_arguments: { label: 'This is a tooltip!' })) do |c| %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #     <%= c.avatar(src: "http://placekitten.com/200/200", alt: "@kittenuser") %>
+    #   <% end  %>
+    #
+    # @param align [Symbol] <%= one_of(Primer::AvatarStackComponent::ALIGN_OPTIONS) %>
+    # @param tooltipped [Boolean] Whether to add a tooltip to the stack or not.
+    # @param body_arguments [Hash] Parameters to add to the Body. If `tooltipped` is set, has the same arguments as <%= link_to_component(Primer::TooltipComponent) %>.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(align: ALIGN_DEFAULT, tooltipped: false, body_arguments: {}, **system_arguments)
+      @align = fetch_or_fallback(ALIGN_OPTIONS, align, ALIGN_DEFAULT)
+      @system_arguments = system_arguments
+      @tooltipped = tooltipped
+      @body_arguments = body_arguments
+
+      @body_arguments[:tag] ||= :div
+      @body_arguments[:classes] = class_names(
+        "AvatarStack-body",
+        @body_arguments[:classes]
+      )
+
+      @system_arguments[:tag] ||= :div
+      @system_arguments[:classes] = class_names(
+        "AvatarStack",
+        system_arguments[:classes],
+        "AvatarStack--right" => @align == :right
+      )
+    end
+
+    def body_component
+      if @tooltipped
+        Primer::TooltipComponent.new(**@body_arguments)
+      else
+        Primer::BaseComponent.new(**@body_arguments)
+      end
+    end
+
+    def before_render
+      @system_arguments[:classes] = class_names(
+        @system_arguments[:classes],
+        "AvatarStack--two" => avatars.size == 2,
+        "AvatarStack--three-plus" => avatars.size > 2
+      )
+    end
+
+    def render?
+      avatars.any?
+    end
+  end
+end

data/app/components/primer/base_component.rb

@@ -76,11 +76,11 @@ module Primer
     #
     # @param underline [Boolean] Whether text should be underlined.
     #
-    # @param color [Symbol] Text color. <%= one_of([:blue, :red, :gray_light, :gray, :gray_dark, :green, :orange, :orange_light, :purple, :pink, :white, :inherit]) %> Note: this API is subject to change as we move to functional colors.
+    # @param color [Symbol] Text color. <%= one_of([:blue, :red, :gray_light, :gray, :gray_dark, :green, :orange, :orange_light, :purple, :pink, :white, :inherit, :text_primary, :text_secondary, :text_tertiary, :text_link, :text_success, :text_warning, :text_danger, :icon_primary, :icon_secondary, :icon_tertiary, :icon_info, :icon_success, :icon_warning, :icon_danger]) %>
     # @param bg [String, Symbol] Background color. Accepts either a hex value as a String or a color name as a Symbol.
     #
     # @param box_shadow [Boolean, Symbol] Box shadow. <%= one_of([true, :medium, :large, :extra_large, :none]) %>
-    # @param border [Symbol] <%= one_of([:left, :top, :bottom, :right, :y, :x]) %>
+    # @param border [Symbol] <%= one_of([:left, :top, :bottom, :right, :y, :x, true]) %>
     # @param border_color [Symbol] <%= one_of([:blue, :blue_light, :gray, :gray_dark, :green, :purple, :red, :red_light, :white, :yellow, :black_fade]) %> Note: this API is subject to change as we move to functional colors.
     # @param border_top [Integer] Set to `0` to remove the top border.
     # @param border_bottom [Integer] Set to `0` to remove the bottom border.
@@ -116,7 +116,7 @@ module Primer
     end
 
     def call
-      content_tag(@tag, content, { **@content_tag_args.merge(@result) })
+      content_tag(@tag, content, @content_tag_args.merge(@result))
     end
 
     private

data/app/components/primer/blankslate_component.rb

@@ -8,20 +8,20 @@ module Primer
     with_slot :spinner, class_name: "Spinner"
 
     #
-    # @example 150|Basic
+    # @example auto|Basic
     #   <%= render Primer::BlankslateComponent.new(
     #     title: "Title",
     #     description: "Description",
     #   ) %>
     #
-    # @example 190|Icon|Add an `icon` to give additional context. Refer to the [Octicons](https://primer.style/octicons/) documentation to choose an icon.
+    # @example auto|Icon|Add an `icon` to give additional context. Refer to the [Octicons](https://primer.style/octicons/) documentation to choose an icon.
     #   <%= render Primer::BlankslateComponent.new(
     #     icon: "octoface",
     #     title: "Title",
     #     description: "Description",
     #   ) %>
     #
-    # @example 220|Loading|Add a [SpinnerComponent](https://primer.style/view-components/components/spinner) to the blankslate in place of an icon.
+    # @example auto|Loading|Add a [SpinnerComponent](https://primer.style/view-components/components/spinner) to the blankslate in place of an icon.
     #   <%= render Primer::BlankslateComponent.new(
     #     title: "Title",
     #     description: "Description",
@@ -29,14 +29,14 @@ module Primer
     #     <% component.slot(:spinner, size: :large) %>
     #   <% end %>
     #
-    # @example 150|Custom content|Pass custom content as a block in place of `description`.
+    # @example auto|Custom content|Pass custom content as a block in place of `description`.
     #   <%= render Primer::BlankslateComponent.new(
     #     title: "Title",
     #   ) do %>
     #     <em>Your custom content here</em>
     #   <% end %>
     #
-    # @example 270|Action button|Provide a button to guide users to take action from the blankslate. The button appears below the description and custom content.
+    # @example auto|Action button|Provide a button to guide users to take action from the blankslate. The button appears below the description and custom content.
     #   <%= render Primer::BlankslateComponent.new(
     #     icon: "book",
     #     title: "Welcome to the mona wiki!",
@@ -46,7 +46,7 @@ module Primer
     #     button_url: "https://github.com/monalisa/mona/wiki/_new",
     #   ) %>
     #
-    # @example 225|Link|Add an additional link to help users learn more about a feature. The link will be shown at the very bottom:
+    # @example auto|Link|Add an additional link to help users learn more about a feature. The link will be shown at the very bottom:
     #   <%= render Primer::BlankslateComponent.new(
     #     icon: "book",
     #     title: "Welcome to the mona wiki!",
@@ -55,7 +55,7 @@ module Primer
     #     link_url: "https://docs.github.com/en/github/building-a-strong-community/about-wikis",
     #   ) %>
     #
-    # @example 340|Variations|There are a few variations of how the Blankslate appears: `narrow` adds a maximum width, `large` increases the font size, and `spacious` adds extra padding.
+    # @example auto|Variations|There are a few variations of how the Blankslate appears: `narrow` adds a maximum width, `large` increases the font size, and `spacious` adds extra padding.
     #   <%= render Primer::BlankslateComponent.new(
     #     icon: "book",
     #     title: "Welcome to the mona wiki!",
@@ -125,7 +125,7 @@ module Primer
       @link_url = link_url
     end
 
-    # :nodoc
+    # :nodoc:
     class Spinner < Primer::Slot
       # @param size [Symbol] <%= one_of(Primer::SpinnerComponent::SIZE_MAPPINGS) %>
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

data/app/components/primer/border_box_component.rb

@@ -10,31 +10,43 @@ module Primer
     with_slot :footer, class_name: "Footer"
     with_slot :row, collection: true, class_name: "Row"
 
-    # @example 350|Header, body, rows, and footer
-    #   <%= render(Primer::BorderBoxComponent.new) do |component|
-    #     component.slot(:header) { "Header" }
-    #     component.slot(:body) { "Body" }
-    #     component.slot(:row) { "Row one" }
-    #     component.slot(:row) { "Row two" }
-    #     component.slot(:row) { "Row three" }
-    #     component.slot(:footer) { "Footer" }
-    #   end %>
+    # @example auto|Header, body, rows, and footer
+    #   <%= render(Primer::BorderBoxComponent.new) do |component| %>
+    #     <% component.slot(:header) do %>
+    #       Header
+    #     <% end %>
+    #     <% component.slot(:body) do %>
+    #       Body
+    #     <% end %>
+    #     <% component.slot(:row) do %>
+    #       <% if true %>
+    #         Row one
+    #       <% end %>
+    #     <% end %>
+    #     <% component.slot(:row) do %>
+    #       Row two
+    #     <% end %>
+    #     <% component.slot(:footer) do %>
+    #       Footer
+    #     <% end %>
+    #   <% 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(
-        "Box",
-        system_arguments[:classes]
-      )
+      @system_arguments[:classes] = class_names("Box", system_arguments[:classes])
     end
 
     def render?
       rows.any? || header.present? || body.present? || footer.present?
     end
 
-    # :nodoc
+    def self.status
+      Primer::Component::STATUSES[:beta]
+    end
+
+    # :nodoc:
     class Header < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -48,7 +60,7 @@ module Primer
       end
     end
 
-    # :nodoc
+    # :nodoc:
     class Body < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -62,7 +74,7 @@ module Primer
       end
     end
 
-    # :nodoc
+    # :nodoc:
     class Footer < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -76,7 +88,7 @@ module Primer
       end
     end
 
-    # :nodoc
+    # :nodoc:
     class Row < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

data/app/components/primer/box_component.rb

@@ -3,10 +3,10 @@
 module Primer
   # A basic wrapper component for most layout related needs.
   class BoxComponent < Primer::Component
-    # @example 20|Default
+    # @example auto|Default
     #   <%= render(Primer::BoxComponent.new) { "Your content here" } %>
     #
-    # @example 54|Color and padding
+    # @example auto|Color and padding
     #   <%= render(Primer::BoxComponent.new(bg: :gray, p: 3)) { "Hello world" } %>
     #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

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 %>

data/app/components/primer/button_component.rb

@@ -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.rb

@@ -5,9 +5,12 @@ module Primer
   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 50|Default
+    # @example auto|Default
     #   <%= render(Primer::ButtonGroupComponent.new) do |component|
     #     component.button { "Default" }
     #     component.button(button_type: :primary) { "Primary" }

data/app/components/primer/button_marketing_component.rb

@@ -25,7 +25,7 @@ module Primer
     DEFAULT_TYPE = :button
     TYPE_OPTIONS = [DEFAULT_TYPE, :submit].freeze
 
-    # @example 125|Button types
+    # @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" } %>
@@ -33,7 +33,7 @@ module Primer
     #     <%= render(Primer::ButtonMarketingComponent.new(button_type: :transparent)) { "Transparent" } %>
     #   </div>
     #
-    # @example 75|Sizes
+    # @example auto|Sizes
     #   <%= render(Primer::ButtonMarketingComponent.new(mr: 2)) { "Default" } %>
     #   <%= render(Primer::ButtonMarketingComponent.new(variant: :large)) { "Large" } %>
     #