primer_view_components 0.0.13 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 055f773c8e99df5c9bce23d6a5199e71148d0331d6abe6c02fd1f16321a54130
-  data.tar.gz: e5310f927e76533daa46918acb24b48ea7bdd684a8f8e4c9090e3545a2e7f3fd
+  metadata.gz: 3e5a191f5ef0c2e50f095bce5d68943ebdc38a28d0edd66334152e876045d9cd
+  data.tar.gz: 8a103a45a9fed84736298a7b75c45b5f2bff3e78817fd4b02100853dbdf9003e
 SHA512:
-  metadata.gz: e6b7159b56e4a0674a7ec68e4aa0666bb2a3e3cb5ef7b90e8c418149200af1255789adc87e4b3955a9a2d6e97afb9ebe2746928ccb32ece3395c28de315206dc
-  data.tar.gz: cc962a06f62249016eccfd224ab3655117ac193fa7f6ebb40aff91212690464047f95e2822bf4b5c8ae83d8c82df02e955f0c8ffc350e9aed85c313623388a61
+  metadata.gz: 467aa20851a1b48cb605984b87a76f0297e5eddd32cee077a8f3cc7a06639829bf6f4dbf79fa81c4aa18f3b6b9cf697867cc8b347a9547d408a7c2aefddd3886
+  data.tar.gz: 9ad2bd67f630a6e734d6b08da43cad5b94482d0ff93085e65f8e8a4ffcf36e150bc7e5ec3beaa542b54a7f9949ff6411da8c6a3db0df460c4e430b0471a03fda

data/CHANGELOG.md

@@ -2,6 +2,56 @@
 
 ## main
 
+## 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.
+
+    *Joel Hawksley*
+
 ## 0.0.13
 
 * Add support for `xl` breakpoint.

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]) %> Note: this API is subject to change as we move to functional colors.
+    # @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_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,6 +3,10 @@
 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
     #   <%= render Primer::BlankslateComponent.new(
@@ -17,6 +21,14 @@ module Primer
     #     description: "Description",
     #   ) %>
     #
+    # @example 220|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 150|Custom content|Pass custom content as a block in place of `description`.
     #   <%= render Primer::BlankslateComponent.new(
     #     title: "Title",
@@ -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

data/app/components/primer/border_box_component.rb

@@ -34,6 +34,7 @@ module Primer
       rows.any? || header.present? || body.present? || footer.present?
     end
 
+    # :nodoc
     class Header < Primer::Slot
       attr_reader :system_arguments
       # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
@@ -47,6 +48,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 +62,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 +76,7 @@ module Primer
       end
     end
 
+    # :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,6 +3,12 @@
 module Primer
   # A basic wrapper component for most layout related needs.
   class BoxComponent < Primer::Component
+    # @example 20|Default
+    #   <%= render(Primer::BoxComponent.new) { "Your content here" } %>
+    #
+    # @example 54|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

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

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,34 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use ButtonGroupComponent to render a series of buttons.
+  class ButtonGroupComponent < Primer::Component
+    include ViewComponent::SlotableV2
+
+    renders_many :buttons, ->(**kwargs) { Primer::ButtonComponent.new(group_item: true, **kwargs) }
+
+    # @example 50|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 125|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 75|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