primer_view_components 0.0.41 → 0.0.46

data/app/components/primer/details_component.rb

@@ -5,6 +5,8 @@ module Primer
   class DetailsComponent < Primer::Component
     status :beta
 
+    BODY_TAG_DEFAULT = :div
+    BODY_TAG_OPTIONS = [:ul, :"details-menu", :"details-dialog", BODY_TAG_DEFAULT].freeze
     NO_OVERLAY = :none
     OVERLAY_MAPPINGS = {
       NO_OVERLAY => "",
@@ -14,7 +16,7 @@ module Primer
 
     # Use the Summary slot as a trigger to reveal the content.
     #
-    # @param button [Boolean] Whether to render the Summary as a button or not.
+    # @param button [Boolean] (true) Whether to render the Summary as a button or not.
     # @param kwargs [Hash] The same arguments as <%= link_to_system_arguments_docs %>.
     renders_one :summary, lambda { |button: true, **system_arguments|
       system_arguments[:tag] = :summary
@@ -27,12 +29,25 @@ module Primer
 
     # Use the Body slot as the main content to be shown when triggered by the Summary.
     #
+    # @param tag [String] (Primer::DetailsComponent::BODY_TAG_DEFAULT) <%= one_of(Primer::DetailsComponent::BODY_TAG_OPTIONS) %>
     # @param kwargs [Hash] The same arguments as <%= link_to_system_arguments_docs %>.
-    renders_one :body, lambda { |**system_arguments|
-      system_arguments[:tag] ||= :div
+    renders_one :body, lambda { |tag: BODY_TAG_DEFAULT, **system_arguments|
+      system_arguments[:tag] = fetch_or_fallback(BODY_TAG_OPTIONS, tag, BODY_TAG_DEFAULT)
+
       Primer::BaseComponent.new(**system_arguments)
     }
 
+    # @example Default
+    #
+    #   <%= render Primer::DetailsComponent.new do |c| %>
+    #     component.summary do
+    #       "Summary"
+    #     end
+    #     component.body do
+    #       "Body"
+    #     end
+    #   <% end %>
+    #
     # @param overlay [Symbol] Dictates the type of overlay to render with. <%= one_of(Primer::DetailsComponent::OVERLAY_MAPPINGS.keys) %>
     # @param reset [Boolean] Defatuls to false. If set to true, it will remove the default caret and remove style from the summary element
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

data/app/components/primer/dropdown.d.ts

@@ -0,0 +1 @@
+import './dropdown/menu';

data/app/components/primer/{dropdown_component.html.erb → dropdown.html.erb}

@@ -1,6 +1,7 @@
 <%= render(Primer::DetailsComponent.new(**@system_arguments)) do |c| %>
-  <% c.summary(classes: @summary_classes) do %>
+  <% c.summary(**@button_arguments) do %>
     <%= button %>
+    <% if @with_caret %><div class="dropdown-caret"></div><% end %>
   <% end %>
 
   <% c.body do %>

data/app/components/primer/dropdown.js

@@ -0,0 +1 @@
+import './dropdown/menu';

data/app/components/primer/dropdown.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Primer
+  # `Dropdown` is a lightweight context menu for housing navigation and actions.
+  # They're great for instances where you don't need the full power (and code) of the SelectMenu.
+  class Dropdown < Primer::Component
+    # Required trigger for the dropdown. Has the same arguments as <%= link_to_component(Primer::ButtonComponent) %>,
+    # but it is locked as a `summary` tag.
+    renders_one :button, lambda { |**system_arguments, &block|
+      @button_arguments = system_arguments
+      @button_arguments[:button] = true
+
+      view_context.capture { block&.call }
+    }
+
+    # Required context menu for the dropdown.
+    #
+    # @param as [Symbol] When `as` is `:list`, wraps the menu in a `<ul>` with a `<li>` for each item.
+    # @param direction [Symbol] <%= one_of(Primer::Dropdown::Menu::DIRECTION_OPTIONS) %>
+    # @param scheme [Symbol] Pass `:dark` for dark mode theming
+    # @param header [String] Optional string to display as the header
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_one :menu, "Primer::Dropdown::Menu"
+
+    # @example Default
+    #   <%= render(Primer::Dropdown.new) do |c| %>
+    #     <% c.button do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(header: "Options") do |menu|
+    #       menu.item { "Item 1" }
+    #       menu.item { "Item 2" }
+    #       menu.item { "Item 3" }
+    #     end %>
+    #   <% end %>
+    #
+    # @example With dividers
+    #
+    #   @description
+    #     Dividers can be used to separate a group of items. They don't have any content.
+    #   @code
+    #     <%= render(Primer::Dropdown.new) do |c| %>
+    #       <% c.button do %>
+    #         Dropdown
+    #       <% end %>
+    #
+    #       <%= c.menu(header: "Options") do |menu|
+    #         menu.item { "Item 1" }
+    #         menu.item { "Item 2" }
+    #         menu.item(divider: true)
+    #         menu.item { "Item 3" }
+    #         menu.item { "Item 4" }
+    #         menu.item(divider: true)
+    #         menu.item { "Item 5" }
+    #         menu.item { "Item 6" }
+    #       end %>
+    #     <% end %>
+    #
+    # @example With direction
+    #   <%= render(Primer::Dropdown.new(display: :inline_block)) do |c| %>
+    #     <% c.button do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(header: "Options", direction: :s) do |menu|
+    #       menu.item { "Item 1" }
+    #       menu.item { "Item 2" }
+    #       menu.item { "Item 3" }
+    #       menu.item { "Item 4" }
+    #     end %>
+    #   <% end %>
+    #
+    # @example With caret
+    #   <%= render(Primer::Dropdown.new(with_caret: true)) do |c| %>
+    #     <% c.button do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(header: "Options") do |menu|
+    #       menu.item { "Item 1" }
+    #       menu.item { "Item 2" }
+    #       menu.item { "Item 3" }
+    #       menu.item { "Item 4" }
+    #     end %>
+    #   <% end %>
+    #
+    # @example Customizing the button
+    #   <%= render(Primer::Dropdown.new) do |c| %>
+    #     <% c.button(scheme: :primary, variant: :small) do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(header: "Options") do |menu|
+    #       menu.item { "Item 1" }
+    #       menu.item { "Item 2" }
+    #       menu.item { "Item 3" }
+    #       menu.item { "Item 4" }
+    #     end %>
+    #   <% end %>
+    #
+    # @example Menu as list
+    #   <%= render(Primer::Dropdown.new) do |c| %>
+    #     <% c.button do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(as: :list, header: "Options") do |menu|
+    #       menu.item { "Item 1" }
+    #       menu.item { "Item 2" }
+    #       menu.item(divider: true)
+    #       menu.item { "Item 3" }
+    #       menu.item { "Item 4" }
+    #     end %>
+    #   <% end %>
+    #
+    # @example Customizing menu items
+    #   <%= render(Primer::Dropdown.new) do |c| %>
+    #     <% c.button do %>
+    #       Dropdown
+    #     <% end %>
+    #
+    #     <%= c.menu(header: "Options") do |menu|
+    #       menu.item(tag: :button) { "Item 1" }
+    #       menu.item(classes: "custom-class") { "Item 2" }
+    #       menu.item { "Item 3" }
+    #     end %>
+    #   <% end %>
+    #
+    # @param overlay [Symbol] <%= one_of(Primer::DetailsComponent::OVERLAY_MAPPINGS.keys) %>
+    # @param with_caret [Boolean] Whether or not a caret should be rendered in the button.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(overlay: :default, with_caret: false, **system_arguments)
+      @with_caret = with_caret
+
+      @system_arguments = system_arguments
+      @system_arguments[:overlay] = overlay
+      @system_arguments[:reset] = true
+      @system_arguments[:classes] = class_names(
+        @system_arguments[:classes],
+        "dropdown"
+      )
+    end
+
+    def render?
+      button.present? && menu.present?
+    end
+  end
+end

data/app/components/primer/dropdown.ts

@@ -0,0 +1 @@
+import './dropdown/menu'

data/app/components/primer/dropdown/menu.d.ts

@@ -0,0 +1 @@
+import '@github/details-menu-element';

data/app/components/primer/dropdown/menu.html.erb

@@ -0,0 +1,25 @@
+<%= render Primer::BaseComponent.new(**@system_arguments) do %>
+  <% if @header.present? %>
+    <div class="dropdown-header">
+      <%= @header %>
+    </div>
+  <% end %>
+
+  <% if list? %>
+    <ul>
+      <% items.each do |item| %>
+        <% if item.divider? %>
+          <%= item %>
+        <% else %>
+          <li>
+            <%= item %>
+          </li>
+        <% end %>
+      <% end %>
+    </ul>
+  <% else %>
+    <% items.each do |item| %>
+      <%= item %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/components/primer/dropdown/menu.js

@@ -0,0 +1 @@
+import '@github/details-menu-element';

data/app/components/primer/dropdown/menu.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Primer
+  class Dropdown
+    # This component is part of `Dropdown` and should not be
+    # used as a standalone component.
+    class Menu < Primer::Component
+      AS_DEFAULT = :default
+      AS_OPTIONS = [AS_DEFAULT, :list].freeze
+
+      SCHEME_DEFAULT = :default
+      SCHEME_MAPPINGS = {
+        SCHEME_DEFAULT => "",
+        :dark => "dropdown-menu-dark"
+      }.freeze
+
+      DIRECTION_DEFAULT = :se
+      DIRECTION_OPTIONS = [DIRECTION_DEFAULT, :sw, :w, :e, :ne, :s].freeze
+
+      # @param tag [Symbol] <%= one_of(Primer::Dropdown::Menu::Item::TAG_OPTIONS) %>.
+      # @param divider [Boolean] Whether the item is a divider without any function.
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      renders_many :items, lambda { |divider: false, **system_arguments|
+        Primer::Dropdown::Menu::Item.new(as: @as, divider: divider, **system_arguments)
+      }
+
+      # @param as [Symbol] When `as` is `:list`, wraps the menu in a `<ul>` with a `<li>` for each item.
+      # @param direction [Symbol] <%= one_of(Primer::Dropdown::Menu::DIRECTION_OPTIONS) %>.
+      # @param header [String] Header to be displayed above the menu.
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      def initialize(as: AS_DEFAULT, direction: DIRECTION_DEFAULT, scheme: SCHEME_DEFAULT, header: nil, **system_arguments)
+        @header = header
+        @direction = direction
+        @as = fetch_or_fallback(AS_OPTIONS, as, AS_DEFAULT)
+
+        @system_arguments = system_arguments
+        @system_arguments[:tag] = "details-menu"
+        @system_arguments[:role] = "menu"
+
+        @system_arguments[:classes] = class_names(
+          @system_arguments[:classes],
+          "dropdown-menu",
+          "dropdown-menu-#{fetch_or_fallback(DIRECTION_OPTIONS, direction, DIRECTION_DEFAULT)}",
+          SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_MAPPINGS.keys, scheme, SCHEME_DEFAULT)]
+        )
+      end
+
+      private
+
+      def list?
+        @as == :list
+      end
+
+      # Items to be rendered in the `Dropdown` menu.
+      class Item < Primer::Component
+        TAG_DEFAULT = :a
+        BUTTON_TAGS = [:button, :summary].freeze
+        TAG_OPTIONS = [TAG_DEFAULT, *BUTTON_TAGS].freeze
+
+        def initialize(as:, tag: TAG_DEFAULT, divider: false, **system_arguments)
+          @divider = divider
+          @as = as
+
+          @system_arguments = system_arguments
+          @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, TAG_DEFAULT)
+          @system_arguments[:tag] = :li if list? && divider?
+          @system_arguments[:role] ||= :menuitem
+          @system_arguments[:role] = :separator if divider
+          @system_arguments[:classes] = class_names(
+            @system_arguments[:classes],
+            "dropdown-item" => !divider,
+            "dropdown-divider" => divider
+          )
+        end
+
+        def call
+          component = if BUTTON_TAGS.include?(@system_arguments[:tag])
+                        Primer::ButtonComponent.new(scheme: :link, **@system_arguments)
+                      else
+                        Primer::BaseComponent.new(**@system_arguments)
+                      end
+
+          # divider has no content
+          render(component) if divider?
+
+          render(component) { content }
+        end
+
+        def divider?
+          @divider
+        end
+
+        def list?
+          @as == :list
+        end
+      end
+    end
+  end
+end

data/app/components/primer/dropdown/menu.ts

@@ -0,0 +1 @@
+import '@github/details-menu-element'

data/app/components/primer/heading_component.rb

@@ -5,7 +5,7 @@ module Primer
   #
   # - Set tag to one of `:h1`, `:h2`, `:h3`, `:h4`, `:h5`, `:h6` based on what is appropriate for the page context.
   # - Use `Heading` as the title of a section or sub section.
-  # - Do not use `Heading` for styling alone. For simply styling text, consider using <%= link_to_component(Primer::TextComponent) %> with relevant <%= link_to_typography_docs %>
+  # - Do not use `Heading` for styling alone. For simply styling text, consider using <%= link_to_component(Primer::Beta::Text) %> with relevant <%= link_to_typography_docs %>
   #   such as `font_size` and `font_weight`.
   # - Do not jump heading levels. For instance, do not follow a `<h1>` with an `<h3>`. Heading levels should increase by one in ascending order.
   #

data/app/components/primer/hidden_text_expander.rb

@@ -10,14 +10,14 @@ module Primer
     #   <%= render(Primer::HiddenTextExpander.new(inline: true)) %>
     #
     # @example Styling the button
-    #   <%= render(Primer::HiddenTextExpander.new(button_arguments: { p: 1, classes: "my-custom-class" })) %>
+    #   <%= render(Primer::HiddenTextExpander.new(button_arguments: { p: 1, classes: "custom-class" })) %>
     #
     # @param inline [Boolean] Whether or not the expander is inline.
     # @param button_arguments [Hash] <%= link_to_system_arguments_docs %> for the button element.
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(inline: false, button_arguments: {}, **system_arguments)
       @system_arguments = system_arguments
-      @system_arguments[:tag] ||= :span
+      @system_arguments[:tag] = :span
       @system_arguments[:classes] = class_names(
         "hidden-text-expander",
         @system_arguments[:classes],

data/app/components/primer/icon_button.rb

@@ -31,7 +31,7 @@ module Primer
     #
     #   <%= render(Primer::BorderBoxComponent.new) do |component| %>
     #     <% component.body do %>
-    #       <%= render(Primer::TextComponent.new(pr: 2)) { "Body" } %>
+    #       <%= render(Primer::Beta::Text.new(pr: 2)) { "Body" } %>
     #       <%= render(Primer::IconButton.new(icon: :pencil, box: true, "aria-label": "Edit")) %>
     #     <% end %>
     #   <% end %>

data/app/components/primer/image_crop.rb

@@ -6,7 +6,7 @@ module Primer
     # A loading indicator that is shown while the image is loading.
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     renders_one :loading, lambda { |**system_arguments|
-      system_arguments[:tag] ||= :div
+      system_arguments[:tag] = :div
       system_arguments[:"data-loading-slot"] = true
 
       Primer::BaseComponent.new(**system_arguments)
@@ -20,7 +20,7 @@ module Primer
     #
     # @example Cropper with a custom loader
     #   <%= render(Primer::ImageCrop.new(src: "https://github.com/koddsson.png", rounded: false)) do |cropper| %>
-    #     <% cropper.loading(style: "width: 120px", tag: :img, src: "spinner.gif") %>
+    #     <% cropper.loading(style: "width: 120px").with_content("Loading...") %>
     #   <% end %>
     #
     # @param src [String] The path of the image to crop.

data/app/components/primer/markdown.rb

@@ -4,6 +4,9 @@ module Primer
   # Use `Markdown` to wrap markdown content
   class Markdown < Primer::Component
     status :beta
+
+    DEFAULT_TAG = :div
+    TAG_OPTIONS = [DEFAULT_TAG, :article, :td].freeze
     # @example Default
     #   <%= render(Primer::Markdown.new) do %>
     #     <p>Text can be <b>bold</b>, <i>italic</i>, or <s>strikethrough</s>. <a href="https://github.com">Links </a> should be blue with no underlines (unless hovered over).</p>
@@ -276,10 +279,11 @@ module Primer
     #     <pre><code>This is the final element on the page and there should be no margin below this.</code></pre>
     #   <% end %>
     #
+    # @param tag [Symbol] <%= one_of(Primer::Markdown::TAG_OPTIONS) %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    def initialize(**system_arguments)
+    def initialize(tag: DEFAULT_TAG, **system_arguments)
       @system_arguments = system_arguments
-      @system_arguments[:tag] ||= :div
+      @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
 
       @system_arguments[:classes] = class_names(
         "markdown-body",

data/app/components/primer/menu_component.rb

@@ -3,11 +3,15 @@
 module Primer
   # Use `Menu` to create vertical lists of navigational links.
   class MenuComponent < Primer::Component
+    HEADING_TAG_OPTIONS = [:h1, :h2, :h3, :h4, :h5, :h6].freeze
+    HEADING_TAG_FALLBACK = :h2
+
     # Optional menu heading
     #
+    # @param tag [Symbol] <%= one_of(Primer::MenuComponent::HEADING_TAG_OPTIONS) %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    renders_one :heading, lambda { |**system_arguments|
-      system_arguments[:tag] ||= :span
+    renders_one :heading, lambda { |tag:, **system_arguments|
+      system_arguments[:tag] = fetch_or_fallback(HEADING_TAG_OPTIONS, tag, HEADING_TAG_FALLBACK)
       system_arguments[:classes] = class_names(
         "menu-heading",
         system_arguments[:classes]
@@ -35,7 +39,7 @@ module Primer
 
     # @example Default
     #   <%= render(Primer::MenuComponent.new) do |c| %>
-    #     <% c.heading do %>
+    #     <% c.heading(tag: :h2) do %>
     #       Heading
     #     <% end %>
     #     <% c.item(selected: true, href: "#url") do %>