primer_view_components 0.0.16 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa20e643699f825d7867ba90c89def4cb5a4718782a55e1c7f7442cf8544732c
-  data.tar.gz: 4f01e3f6a5a2418b9318362820f08c37ad0dcc420aa62d55e12016f7e56b7e88
+  metadata.gz: 62c2e7e2e043daf8288aa72a91d674af96180cc0430c8d59c5fdbf5764e19b59
+  data.tar.gz: 75b205867ce0f2835ee32d9a859032d02eef6dbb98b8ff5c9d485001893fce5b
 SHA512:
-  metadata.gz: 02be1d647c02508fbc4fb7fd9339d221b7625a5fe047c2e14e5901d809e8c4edbffb1559f4c06dbbb95971e6697b76acd8b096f60087d14941dcddf20c58ff87
-  data.tar.gz: 265ee51bd35a72bb183df848780a9d47b3203a06bb77ee53f7cfb606897785175bc347d48082bd7a0286081235155c4dae4c702fa752dc863342017a1a254d39
+  metadata.gz: f6ad3831ccbb77616d668036954108e3642ffe747ee2837714761ebc54ca353b654813cad3396bb31e4a94f03f6e84f5ae52c75cf07387fffd24758d73967b70
+  data.tar.gz: 79d4aca35c8556fcbbcbab8fb6cf5d4e5440f920508af5ed880bb200a03820869a576ebafd3200ff756a3b7a580855c8b1c77ba71a65f085367fc80ac063e49f

data/CHANGELOG.md

@@ -2,6 +2,88 @@
 
 ## main
 
+## 0.0.21
+
+* **Breaking change**: Upgrade `FlashComponent` to use Slots V2.
+
+    *Joel Hawksley, Simon Taranto*
+
+* **Breaking change**: Upgrade `BlankslateComponent` to use Slots V2.
+
+    *Manuel Puyol*
+
+* **Breaking change**: Upgrade `TimelineItemComponent` to use Slots V2.
+
+    *Manuel Puyol*
+
+## 0.0.20
+
+* Fix bug when empty string was passed to Classify.
+
+    *Manuel Puyol*
+
+## 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.
+
+    *Ash Guillaume*
+
+* Add `animation` system argument.
+
+    *Manuel Puyol*
+
+* Add `Truncate`, `ButtonGroup` and `ButtonMarketing` components.
+
+    *Manuel Puyol*
+
+* Add `Tooltip` component.
+
+    *Simon Taranto*
+
+## 0.0.17
+
+* Ensure all components support inline styles.
+
+    *Joel Hawksley*
+
 ## 0.0.16
 
 * Adding a `spinner` slot to the `BlankslateComponent` that uses the `SpinnerComponent` added in `0.0.10`.

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")) %>
     #
-    # @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
+    # @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

@@ -34,6 +34,7 @@ module Primer
   # | `data` | `Hash` | Data attributes: `data: { foo: :bar }` renders `data-foo='bar'`. |
   # | `aria` | `Hash` | Aria attributes: `aria: { label: "foo" }` renders `aria-label='foo'`. |
   # | `title` | `String` | The `title` attribute. |
+  # | `style` | `String` | Inline styles. |
   # | `hidden` | `Boolean` | Whether to assign the `hidden` attribute. |
   class BaseComponent < Primer::Component
     TEST_SELECTOR_TAG = :test_selector
@@ -61,7 +62,7 @@ module Primer
     # @param bottom [Boolean] If `false`, sets `bottom: 0`.
     # @param left [Boolean] If `false`, sets `left: 0`.
     #
-    # @param display [Symbol] <%= one_of([:block, :none, :inline, :inline_block, :table, :table_cell]) %>
+    # @param display [Symbol] <%= one_of([:none, :block, :flex, :inline, :inline_block, :table, :table_cell]) %>
     #
     # @param v [Symbol] Visibility. <%= one_of([:hidden, :visible]) %>
     #
@@ -75,16 +76,17 @@ 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.
     # @param border_left [Integer] Set to `0` to remove the left border.
     # @param border_right [Integer] Set to `0` to remove the right border.
+    # @param border_radius [Integer] <%= one_of([0, 1, 2, 3]) %>
     #
     # @param font_size [String, Integer] <%= one_of(["00", 0, 1, 2, 3, 4, 5, 6]) %>
     # @param text_align [Symbol] Text alignment. <%= one_of([:left, :right, :center]) %>
@@ -101,6 +103,8 @@ module Primer
     #
     # @param word_break [Symbol] Whether to break words on line breaks. Can only be `:break_all`.
     #
+    # @param animation [Symbol] <%= one_of([:fade_in, :fade_out, :fade_up, :fade_down, :scale_in, :pulse, :grow_x, :grow]) %>
+    #
     # @param tag [Symbol] HTML tag name to be passed to `tag.send`.
     # @param classes [String] CSS class name value to be concatenated with generated Primer CSS classes.
     def initialize(tag:, classes: nil, **system_arguments)
@@ -112,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.html.erb

@@ -1,6 +1,6 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
   <% if spinner.present? %>
-    <%= render spinner.component %>
+    <%= spinner %>
   <% elsif @icon.present? %>
     <%= render(Primer::OcticonComponent.new(
       icon: @icon,

data/app/components/primer/blankslate_component.rb

@@ -3,40 +3,46 @@
 module Primer
   # Use Primer::BlankslateComponent when there is a lack of content within a page or section. Use as placeholder to tell users why something isn't there.
   class BlankslateComponent < Primer::Component
-    include ViewComponent::Slotable
+    include ViewComponent::SlotableV2
 
-    with_slot :spinner, class_name: "Spinner"
+    # Optional Spinner.
+    #
+    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::SpinnerComponent) %>.
+    renders_one :spinner, lambda { |**system_arguments|
+      system_arguments[:mb] ||= 3
+      Primer::SpinnerComponent.new(**system_arguments)
+    }
 
     #
-    # @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",
     #   ) do |component| %>
-    #     <% component.slot(:spinner, size: :large) %>
+    #     <% component.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 +52,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 +61,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!",
@@ -94,7 +100,7 @@ module Primer
       link_text: "",
       link_url: "",
 
-      #variations
+      # variations
       narrow: false,
       large: false,
       spacious: false,
@@ -108,7 +114,7 @@ module Primer
         "blankslate",
         "blankslate-narrow": narrow,
         "blankslate-large": large,
-        "blankslate-spacious": spacious,
+        "blankslate-spacious": spacious
       )
 
       @title_tag = title_tag
@@ -124,18 +130,5 @@ module Primer
       @link_text = link_text
       @link_url = link_url
     end
-
-    class Spinner < Primer::Slot
-      # @param size [Symbol] <%= one_of(Primer::SpinnerComponent::SIZE_MAPPINGS) %>
-      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-      def initialize(**system_arguments)
-        @system_arguments = system_arguments
-        @system_arguments[:mb] ||= 3
-      end
-
-      def component
-        Primer::SpinnerComponent.new(**@system_arguments)
-      end
-    end
   end
 end

data/app/components/primer/border_box_component.rb

@@ -10,30 +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
 
+    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 %>
@@ -47,6 +60,7 @@ module Primer
       end
     end
 
+    # :nodoc:
     class Body < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -60,6 +74,7 @@ module Primer
       end
     end
 
+    # :nodoc:
     class Footer < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -73,6 +88,7 @@ module Primer
       end
     end
 
+    # :nodoc:
     class Row < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>