primer_view_components 0.0.14 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb2ccfdc2a705a1395c0b18dd535b305cf0b00ef77f778fe6bbc9b6417c3f4a
-  data.tar.gz: fa2cea6523b0281502b65d654c11ab4224d345d25a3608a63e92f8680aaeb742
+  metadata.gz: 2123d6cd3a227f0cf3df93cc601098dc6e6b0b59ba98bbc589ccdd6a4c8b0b4f
+  data.tar.gz: b8b5075b18d79f10a385bb51b6f2d17d324a10fb3c5c5c961e841f96713a8c59
 SHA512:
-  metadata.gz: c4506031b1c2e99c36aa9b868e210b15b396b8b38a8347e1b06785510e3caee7b6edb2e4fe0eafb178effa74cd2287e6e7d421d5c04394f5bead62cb0c3b9ffa
-  data.tar.gz: 7e3a7b3a2ca8932cbdb563738d040b5ceb1239736ecf7603a3c9cdfa3cf3bc24aa9df3faa251568b9f8020a119bb75ed439a9881342e7e307b708a742fa42897
+  metadata.gz: b5ce375e1b8fa9d95cd784ea19565a6bfeb1024db7fdc5e010995f2a7085f5b03cfa163979c7b33648eacfd986b4339b1ca1bdba06e5ba581b8b20a006935d62
+  data.tar.gz: 0d6124a56d36eb09075d4be8bc50b8d1e061c2e9137c030733f6b875488f3f15e0939dd5692116e7f2d29cc7ac81ed6adc5f27cdb442e57ad44b8d456e5c60cc

data/CHANGELOG.md

@@ -2,6 +2,88 @@
 
 ## 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.
+
+    *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`.
+
+    *Jon Rohan*
+
+* Bumping node engine to version `15.x`
+
+    *Jon Rohan*
+
+## 0.0.15
+
+* Add ability to disable `limit` on Counter.
+
+    *Christian Giordano*
+
+* Rename `v` system argument to `visibility`.
+
+    *Joel Hawksley*
+
 ## 0.0.14
 
 * Add functional colors to Label.

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Primer
-  # All Primer ViewComponents accept a standard set of options called System Arguments, mimicking the [styled-system API](https://styled-system.com/table) [used by Primer React](https://primer.style/components/system-props).
+  # All Primer ViewComponents accept a standard set of options called system arguments, mimicking the [styled-system API](https://styled-system.com/table) used by [Primer React](https://primer.style/components/system-props).
   #
-  # Under the hood, System Arguments are [mapped](https://github.com/primer/view_components/blob/main/lib/primer/classify.rb) to Primer CSS classes, with any remaining options passed to Rails' [`content_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag).
+  # Under the hood, system arguments are [mapped](https://github.com/primer/view_components/blob/main/lib/primer/classify.rb) to Primer CSS classes, with any remaining options passed to Rails' [`content_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-content_tag).
   #
   # ## Responsive values
   #
@@ -23,9 +23,23 @@ module Primer
   # <h1 class="mt-0 mt-lg-4 mt-xl-2">Hello world</h1>
   # ```
   #
+  # ## HTML attributes
+  #
+  # System arguments include most HTML attributes. For example:
+  #
+  # | Name | Type | Description |
+  # | :- | :- | :- |
+  # | `width` | `Integer` | Width. |
+  # | `height` | `Integer` | Height. |
+  # | `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
-
+    # @param test_selector [String] Adds `data-test-selector='given value'` in non-Production environments for testing purposes.
+    #
     # @param m [Integer] Margin. <%= one_of((-6..6).to_a) %>
     # @param mt [Integer] Margin left. <%= one_of((-6..6).to_a) %>
     # @param mr [Integer] Margin right. <%= one_of((-6..6).to_a) %>
@@ -33,13 +47,13 @@ module Primer
     # @param ml [Integer] Margin left. <%= one_of((-6..6).to_a) %>
     # @param mx [Integer] Horizontal margins. <%= one_of((-6..6).to_a + [:auto]) %>
     # @param my [Integer] Vertical margins. <%= one_of((-6..6).to_a) %>
-    # @param m [Integer] Padding. <%= one_of((0..6).to_a) %>
-    # @param mt [Integer] Padding left. <%= one_of((0..6).to_a) %>
-    # @param mr [Integer] Padding right. <%= one_of((0..6).to_a) %>
-    # @param mb [Integer] Padding bottom. <%= one_of((0..6).to_a) %>
-    # @param ml [Integer] Padding left. <%= one_of((0..6).to_a) %>
-    # @param mx [Integer] Horizontal padding. <%= one_of((0..6).to_a) %>
-    # @param my [Integer] Vertical padding. <%= one_of((0..6).to_a) %>
+    # @param p [Integer] Padding. <%= one_of((0..6).to_a) %>
+    # @param pt [Integer] Padding left. <%= one_of((0..6).to_a) %>
+    # @param pr [Integer] Padding right. <%= one_of((0..6).to_a) %>
+    # @param pb [Integer] Padding bottom. <%= one_of((0..6).to_a) %>
+    # @param pl [Integer] Padding left. <%= one_of((0..6).to_a) %>
+    # @param px [Integer] Horizontal padding. <%= one_of((0..6).to_a) %>
+    # @param py [Integer] Vertical padding. <%= one_of((0..6).to_a) %>
     #
     # @param position [Symbol] <%= one_of([:relative, :absolute, :fixed]) %>
     #
@@ -48,7 +62,9 @@ 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]) %>
     #
     # @param hide [Symbol] Hide the element at a specific breakpoint. <%= one_of([:sm, :md, :lg, :xl]) %>
     #
@@ -56,9 +72,41 @@ module Primer
     #
     # @param float [Symbol] <%= one_of([:left, :right]) %>
     #
-    # @param font_size [String] <%= one_of(["00", "0", "1", "2", "3", "4", "5", "6"]) %>
-    # @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
+    # @param col [Integer] Number of columns.
+    #
+    # @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, :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, 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]) %>
+    # @param font_weight [Symbol] Font weight. <%= one_of([:light, :normal, :bold]) %>
+    #
+    # @param flex [Integer, Symbol] <%= one_of([1, :auto]) %>
+    # @param flex_grow [Integer] To enable, set to `0`.
+    # @param flex_shrink [Integer] To enable, set to `0`.
+    # @param align_self [Symbol] <%= one_of([:auto, :start, :end, :center, :baseline, :stretch]) %>
+    # @param justify_content [Symbol] <%= one_of([:flex_start, :flex_end, :center, :space_between, :space_around]) %>
+    # @param align_items [Symbol] <%= one_of([:flex_start, :flex_end, :center, :baseline, :stretch]) %>
+    # @param width [Symbol] <%= one_of([:fit, :fill]) %>
+    # @param height [Symbol] <%= one_of([:fit, :fill]) %>
+    #
+    # @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)
       @tag = tag
       @result = Primer::Classify.call(**system_arguments.merge(classes: classes))
@@ -68,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,13 +1,13 @@
 <%= render Primer::BaseComponent.new(**@system_arguments) do %>
-  <% if @icon.present? %>
+  <% if spinner.present? %>
+    <%= render spinner.component %>
+  <% elsif @icon.present? %>
     <%= render(Primer::OcticonComponent.new(
       icon: @icon,
       size: @icon_size,
       classes: "blankslate-icon"
     )) %>
-  <% end %>
-
-  <% if @image_src.present? && @image_alt.present? %>
+  <% elsif @image_src.present? && @image_alt.present? %>
     <%= image_tag "#{@image_src}", class: "mb-3", size: "56x56", alt: "#{@image_alt}" %>
   <% end %>
 

data/app/components/primer/blankslate_component.rb

@@ -3,28 +3,40 @@
 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
+
+    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 150|Custom content|Pass custom content as a block in place of `description`.
+    # @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) %>
+    #   <% end %>
+    #
+    # @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!",
@@ -34,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!",
@@ -43,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!",
@@ -82,7 +94,7 @@ module Primer
       link_text: "",
       link_url: "",
 
-      #variations
+      # variations
       narrow: false,
       large: false,
       spacious: false,
@@ -96,7 +108,7 @@ module Primer
         "blankslate",
         "blankslate-narrow": narrow,
         "blankslate-large": large,
-        "blankslate-spacious": spacious,
+        "blankslate-spacious": spacious
       )
 
       @title_tag = title_tag
@@ -112,5 +124,19 @@ module Primer
       @link_text = link_text
       @link_url = link_url
     end
+
+    # :nodoc:
+    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