primer_view_components 0.0.21 → 0.0.22

data/app/components/primer/spinner_component.rb

@@ -15,13 +15,13 @@ module Primer
     DEFAULT_STYLE = "box-sizing: content-box; color: var(--color-icon-primary);"
 
     #
-    # @example auto|Default
+    # @example Default
     #   <%= render(Primer::SpinnerComponent.new) %>
     #
-    # @example auto|Small
+    # @example Small
     #   <%= render(Primer::SpinnerComponent.new(size: :small)) %>
     #
-    # @example auto|Large
+    # @example Large
     #   <%= render(Primer::SpinnerComponent.new(size: :large)) %>
     #
     # @param size [Symbol] <%= one_of(Primer::SpinnerComponent::SIZE_MAPPINGS) %>

data/app/components/primer/state_component.rb

@@ -4,12 +4,19 @@ module Primer
   # Component for rendering the status of an item.
   class StateComponent < Primer::Component
     COLOR_DEFAULT = :default
-    COLOR_MAPPINGS = {
+    NEW_COLOR_MAPPINGS = {
+      open: "State--open",
+      closed: "State--closed",
+      merged: "State--merged"
+    }.freeze
+
+    DEPRECATED_COLOR_MAPPINGS = {
       COLOR_DEFAULT => "",
-      :green => "State--green",
-      :red => "State--red",
-      :purple => "State--purple"
+      :green => "State--open",
+      :red => "State--closed",
+      :purple => "State--merged"
     }.freeze
+    COLOR_MAPPINGS = NEW_COLOR_MAPPINGS.merge(DEPRECATED_COLOR_MAPPINGS)
     COLOR_OPTIONS = COLOR_MAPPINGS.keys
 
     SIZE_DEFAULT = :default
@@ -22,16 +29,16 @@ module Primer
     TAG_DEFAULT = :span
     TAG_OPTIONS = [TAG_DEFAULT, :div, :a].freeze
 
-    # @example auto|Default
+    # @example Default
     #   <%= render(Primer::StateComponent.new(title: "title")) { "State" } %>
     #
-    # @example auto|Colors
+    # @example Colors
     #   <%= render(Primer::StateComponent.new(title: "title")) { "Default" } %>
-    #   <%= render(Primer::StateComponent.new(title: "title", color: :green)) { "Green" } %>
-    #   <%= render(Primer::StateComponent.new(title: "title", color: :red)) { "Red" } %>
-    #   <%= render(Primer::StateComponent.new(title: "title", color: :purple)) { "Purple" } %>
+    #   <%= render(Primer::StateComponent.new(title: "title", color: :open)) { "Open" } %>
+    #   <%= render(Primer::StateComponent.new(title: "title", color: :closed)) { "Closed" } %>
+    #   <%= render(Primer::StateComponent.new(title: "title", color: :merged)) { "Merged" } %>
     #
-    # @example auto|Sizes
+    # @example Sizes
     #   <%= render(Primer::StateComponent.new(title: "title")) { "Default" } %>
     #   <%= render(Primer::StateComponent.new(title: "title", size: :small)) { "Small" } %>
     #
@@ -61,5 +68,9 @@ module Primer
     def call
       render(Primer::BaseComponent.new(**@system_arguments)) { content }
     end
+
+    def self.status
+      Primer::Component::STATUSES[:beta]
+    end
   end
 end

data/app/components/primer/subhead_component.rb

@@ -9,7 +9,7 @@ module Primer
     with_slot :actions, class_name: "Actions"
     with_slot :description, class_name: "Description"
 
-    # @example auto|Default
+    # @example Default
     #   <%= render(Primer::SubheadComponent.new) do |component| %>
     #     <% component.slot(:heading) do %>
     #       My Heading
@@ -19,7 +19,7 @@ module Primer
     #     <% end %>
     #   <% end %>
     #
-    # @example auto|Without border
+    # @example Without border
     #   <%= render(Primer::SubheadComponent.new(hide_border: true)) do |component| %>
     #     <% component.slot(:heading) do %>
     #       My Heading
@@ -29,7 +29,7 @@ module Primer
     #     <% end %>
     #   <% end %>
     #
-    # @example auto|With actions
+    # @example With actions
     #   <%= render(Primer::SubheadComponent.new) do |component| %>
     #     <% component.slot(:heading) do %>
     #       My Heading

data/app/components/primer/tab_container_component.js

@@ -0,0 +1 @@
+import '@github/tab-container-element';

data/app/components/primer/tab_container_component.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use TabContainer to create tabbed content with keyboard support. This component does not add any styles.
+  # It only provides the tab functionality. If you want styled Tabs you can look at <%= link_to_component(Primer::TabNavComponent) %>.
+  #
+  # This component requires javascript.
+  class TabContainerComponent < Primer::Component
+    # @example Default
+    #   <%= render(Primer::TabContainerComponent.new)  do %>
+    #     <div role="tablist">
+    #       <button type="button" role="tab" aria-selected="true">Tab one</button>
+    #       <button type="button" role="tab" tabindex="-1">Tab two</button>
+    #       <button type="button" role="tab" tabindex="-1">Tab three</button>
+    #     </div>
+    #     <div role="tabpanel">
+    #       Panel 1
+    #     </div>
+    #     <div role="tabpanel" hidden>
+    #       Panel 2
+    #     </div>
+    #     <div role="tabpanel" hidden>
+    #       Panel 3
+    #     </div>
+    #   <% end %>
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(**system_arguments)
+      @system_arguments = system_arguments
+      @system_arguments[:tag] = "tab-container"
+    end
+
+    def call
+      render(Primer::BaseComponent.new(**@system_arguments)) { content }
+    end
+
+    def render?
+      content.present?
+    end
+  end
+end

data/app/components/primer/tab_container_component.ts

@@ -0,0 +1 @@
+import '@github/tab-container-element'

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

@@ -0,0 +1,17 @@
+<%= render wrapper.new(**@system_arguments) do %>
+  <nav role="tablist" aria-label="<%= @aria_label %>" class="tabnav-tabs">
+    <% tabs.each do |tab| %>
+      <%= tab %>
+    <% end %>
+  </nav >
+
+  <% if @with_panel %>
+    <% tabs.each do |tab| %>
+      <% if tab.panel.present? %>
+        <div role="tabpanel" <%= "hidden" if tab.hidden? %>>
+          <%= tab.panel %>
+        </div>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/primer/tab_nav_component.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use TabNav to style navigation with a tab-based selected state, typically used for navigation placed at the top of the page.
+  class TabNavComponent < Primer::Component
+    include ViewComponent::SlotableV2
+
+    class MultipleSelectedTabsError < StandardError; end
+    class NoSelectedTabsError < StandardError; end
+
+    # Tabs to be rendered.
+    #
+    # @param title [String] Text to be rendered by the tab.
+    # @param selected [Boolean] Whether the tab is selected.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_many :tabs, lambda { |**system_arguments|
+      return TabComponent.new(**system_arguments) unless @with_panel
+
+      TabComponent.new(tag: :button, type: :button, **system_arguments)
+    }
+
+    # @example Default
+    #   <%= render(Primer::TabNavComponent.new) do |c| %>
+    #     <% c.tab(selected: true, title: "Tab 1", href: "#") %>
+    #     <% c.tab(title: "Tab 2", href: "#") %>
+    #     <% c.tab(title: "Tab 3", href: "#") %>
+    #   <% end %>
+    #
+    # @example With panels
+    #   <%= render(Primer::TabNavComponent.new(with_panel: true)) do |c| %>
+    #     <% c.tab(selected: true, title: "Tab 1") { "Panel 1" } %>
+    #     <% c.tab(title: "Tab 2") { "Panel 1" } %>
+    #     <% c.tab(title: "Tab 3") { "Panel 1" } %>
+    #   <% end %>
+    #
+    # @param aria_label [String] Used to set the `aria-label` on the top level `<nav>` element.
+    # @param with_panel [Boolean] Whether the TabNav should navigate through pages or panels.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(aria_label: nil, with_panel: false, **system_arguments)
+      @aria_label = aria_label
+      @with_panel = with_panel
+      @system_arguments = system_arguments
+      @system_arguments[:tag] ||= :div
+
+      @system_arguments[:classes] = class_names(
+        "tabnav",
+        system_arguments[:classes]
+      )
+    end
+
+    def before_render
+      validate_single_selected_tab
+    end
+
+    private
+
+    def wrapper
+      @with_panel ? Primer::TabContainerComponent : Primer::BaseComponent
+    end
+
+    def validate_single_selected_tab
+      raise MultipleSelectedTabsError, "only one tab can be selected" if selected_tabs_count > 1
+      raise NoSelectedTabsError, "a tab must be selected" if selected_tabs_count != 1
+    end
+
+    def selected_tabs_count
+      @selected_tabs_count ||= tabs.count(&:selected)
+    end
+
+    # Tabs to be rendered.
+    class TabComponent < Primer::Component
+      attr_reader :selected
+
+      def initialize(title:, selected: false, **system_arguments)
+        @title = title
+        @selected = selected
+        @system_arguments = system_arguments
+        @system_arguments[:tag] ||= :a
+        @system_arguments[:role] = :tab
+
+        if selected
+          if @system_arguments[:tag] == :a
+            @system_arguments[:"aria-current"] = :page
+          else
+            @system_arguments[:"aria-selected"] = true
+          end
+        end
+
+        @system_arguments[:classes] = class_names(
+          "tabnav-tab",
+          system_arguments[:classes]
+        )
+      end
+
+      def call
+        render(Primer::BaseComponent.new(**@system_arguments)) { @title }
+      end
+
+      def panel
+        content
+      end
+
+      def hidden?
+        !@selected
+      end
+    end
+  end
+end

data/app/components/primer/text_component.rb

@@ -3,7 +3,7 @@
 module Primer
   # The Text component is a wrapper component that will apply typography styles to the text inside.
   class TextComponent < Primer::Component
-    # @example auto|Default
+    # @example Default
     #   <%= render(Primer::TextComponent.new(tag: :p, font_weight: :bold)) { "Bold Text" } %>
     #   <%= render(Primer::TextComponent.new(tag: :p, color: :red_5)) { "Red Text" } %>
     #

data/app/components/primer/timeline_item_component.rb

@@ -36,7 +36,7 @@ module Primer
       Primer::BaseComponent.new(**system_arguments)
     }
 
-    # @example auto|Default
+    # @example Default
     #   <div style="padding-left: 60px">
     #     <%= render(Primer::TimelineItemComponent.new) do |component| %>
     #       <% component.avatar(src: "https://github.com/github.png", alt: "github") %>

data/app/components/primer/tooltip_component.rb

@@ -26,29 +26,29 @@ module Primer
       se
     ]
 
-    # @example 55|Default
+    # @example Default
     #   <div class="pt-5">
     #     <%= render(Primer::TooltipComponent.new(label: "Even bolder")) { "Default Bold Text" } %>
     #   </div>
     #
-    # @example 65|Wrapping another component
+    # @example Wrapping another component
     #   <div class="pt-5">
     #     <%= render(Primer::TooltipComponent.new(label: "Even bolder")) do %>
     #       <%= render(Primer::ButtonComponent.new) { "Bold Button" } %>
     #     <% end %>
     #   </div>
     #
-    # @example 65|With a direction
+    # @example With a direction
     #   <div class="pt-5">
     #     <%= render(Primer::TooltipComponent.new(label: "Even bolder", direction: :s)) { "Bold Text With a Direction" } %>
     #   </div>
     #
-    # @example 65|With an alignment
+    # @example With an alignment
     #   <div class="pt-5">
     #     <%= render(Primer::TooltipComponent.new(label: "Even bolder", direction: :s, alignment: :right_1)) { "Bold Text With an Alignment" } %>
     #   </div>
     #
-    # @example 65|Without a delay
+    # @example Without a delay
     #   <div class="pt-5">
     #     <%= render(Primer::TooltipComponent.new(label: "Even bolder", direction: :s, no_delay: true)) { "Bold Text without a delay" } %>
     #   </div>

data/app/components/primer/truncate_component.rb

@@ -3,18 +3,18 @@
 module Primer
   # Use TruncateComponent to shorten overflowing text with an ellipsis.
   class TruncateComponent < Primer::Component
-    # @example auto|Default
+    # @example Default
     #   <div class="col-2">
     #     <%= render(Primer::TruncateComponent.new(tag: :p)) { "branch-name-that-is-really-long" } %>
     #   </div>
     #
-    # @example auto|Inline
+    # @example Inline
     #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true)) { "branch-name-that-is-really-long" } %>
     #
-    # @example auto|Expandable
+    # @example Expandable
     #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true, expandable: true)) { "branch-name-that-is-really-long" } %>
     #
-    # @example auto|Custom size
+    # @example Custom size
     #   <%= render(Primer::TruncateComponent.new(tag: :span, inline: true, expandable: true, max_width: 100)) { "branch-name-that-is-really-long" } %>
     #
     # @param inline [Boolean] Whether the element is inline (or inline-block).

data/app/components/primer/underline_nav_component.rb

@@ -10,7 +10,7 @@ module Primer
 
     with_content_areas :body, :actions
 
-    # @example auto|Default
+    # @example Default
     #   <%= render(Primer::UnderlineNavComponent.new) do |component| %>
     #     <% component.with(:body) do %>
     #       <%= render(Primer::LinkComponent.new(href: "#url")) { "Item 1" } %>
@@ -20,7 +20,7 @@ module Primer
     #     <% end %>
     #   <% end %>
     #
-    # @example auto|Align right
+    # @example Align right
     #   <%= render(Primer::UnderlineNavComponent.new(align: :right)) do |component| %>
     #     <% component.with(:body) do %>
     #       <%= render(Primer::LinkComponent.new(href: "#url")) { "Item 1" } %>

data/{lib → app/lib}/primer/classify.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "classify/cache"
-
 module Primer
   # :nodoc:
   class Classify

data/app/lib/primer/view_helper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Primer
+  # Module to allow shorthand calls for registered Primer components
+  #
+  # Registered components can be called with
+  # `primer(:name, **kwargs) { block }` instead of
+  # `render Primer::NameComponent.new(**kwargs) { block }`
+  module ViewHelper
+    extend ActiveSupport::Concern
+
+    class ViewHelperNotFound < StandardError; end
+
+    def primer(name, **component_args, &block)
+      component = Primer::Component.primer_helpers[name]
+
+      raise ViewHelperNotFound, "no component defined for helper #{name}" if component.blank?
+
+      render component.new(**component_args), &block
+    end
+  end
+end

data/app/lib/primer/view_helper/dsl.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Primer
+  # :nodoc:
+  module ViewHelper
+    # DSL to allow components to register a View Helper for shorthand calls.
+    #
+    # Example:
+    #
+    # class MyComponent < ViewComponent::Base
+    #   include Primer::ViewHelper::DSL
+    #   view_helper :my_component
+    # end
+    module DSL
+      extend ActiveSupport::Concern
+
+      class ViewHelperAlreadyDefined < StandardError; end
+
+      included do
+        class_attribute :primer_helpers, instance_writer: false, default: {}
+      end
+
+      class_methods do
+        def view_helper(name)
+          raise ViewHelperAlreadyDefined, "#{name} is already defined" if primer_helpers[name].present?
+
+          primer_helpers[name] = self
+        end
+      end
+    end
+  end
+end