primer_view_components 0.0.40 → 0.0.45

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

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

data/app/components/primer/details_menu_component.js

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

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/flash_component.rb

@@ -35,7 +35,7 @@ module Primer
     #   <%= render(Primer::FlashComponent.new(dismissible: true)) { "This is a dismissible flash message!" } %>
     #
     # @example Icon
-    #   <%= render(Primer::FlashComponent.new(icon: "people")) { "This is a flash message with an icon!" } %>
+    #   <%= render(Primer::FlashComponent.new(icon: :people)) { "This is a flash message with an icon!" } %>
     #
     # @example With actions
     #   <%= render(Primer::FlashComponent.new) do |component| %>
@@ -48,7 +48,7 @@ module Primer
     # @param full [Boolean] Whether the component should take up the full width of the screen.
     # @param spacious [Boolean] Whether to add margin to the bottom of the component.
     # @param dismissible [Boolean] Whether the component can be dismissed with an X button.
-    # @param icon [String] Name of Octicon icon to use.
+    # @param icon [Symbol] Name of Octicon icon to use.
     # @param scheme [Symbol] <%= one_of(Primer::FlashComponent::SCHEME_MAPPINGS.keys) %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(full: false, spacious: false, dismissible: false, icon: nil, scheme: DEFAULT_SCHEME, **system_arguments)

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.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use `Image` to render images.
+  #
+  # @accessibility
+  #   Always provide a meaningful `alt`.
+  class Image < Primer::Component
+    # @example Default
+    #
+    #   <%= render(Primer::Image.new(src: "https://github.com/github.png", alt: "GitHub")) %>
+    #
+    # @example Helper
+    #
+    #   <%= primer_image(src: "https://github.com/github.png", alt: "GitHub") %>
+    #
+    # @example Lazy loading
+    #
+    #   <%= render(Primer::Image.new(src: "https://github.com/github.png", alt: "GitHub", lazy: true)) %>
+    #
+    # @example Custom size
+    #
+    #   <%= render(Primer::Image.new(src: "https://github.com/github.png", alt: "GitHub", height: 100, width: 100)) %>
+    #
+    # @param src [String] The source url of the image.
+    # @param alt [String] Specifies an alternate text for the image.
+    # @param lazy [Boolean] Whether or not to lazily load the image.
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(src:, alt:, lazy: false, **system_arguments)
+      @system_arguments = system_arguments
+
+      @system_arguments[:tag] = :img
+      @system_arguments[:src] = src
+      @system_arguments[:alt] = alt
+
+      return unless lazy
+
+      @system_arguments[:loading] = :lazy
+      @system_arguments[:decoding] = :async
+    end
+
+    def call
+      render(Primer::BaseComponent.new(**@system_arguments))
+    end
+  end
+end

data/app/components/primer/image_crop.rb

@@ -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.
@@ -30,7 +30,7 @@ module Primer
       @system_arguments = system_arguments
       @system_arguments[:tag] = "image-crop"
       @system_arguments[:src] = src
-      @system_arguments[:rounded] = rounded
+      @system_arguments[:rounded] = true if rounded
     end
   end
 end

data/app/components/primer/label_component.rb

@@ -5,6 +5,9 @@ module Primer
   class LabelComponent < Primer::Component
     status :beta
 
+    DEFAULT_TAG = :span
+    TAG_OPTIONS = [DEFAULT_TAG, :summary, :a, :div].freeze
+
     SCHEME_MAPPINGS = {
       primary: "Label--primary",
       secondary: "Label--secondary",
@@ -38,13 +41,14 @@ module Primer
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label")) { "Default" } %>
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", variant: :large)) { "Large" } %>
     #
+    # @param tag [Symbol] <%= one_of(Primer::LabelComponent::TAG_OPTIONS) %>
     # @param title [String] `title` attribute for the component element.
     # @param scheme [Symbol] <%= one_of(Primer::LabelComponent::SCHEME_MAPPINGS.keys) %>
     # @param variant [Symbol] <%= one_of(Primer::LabelComponent::VARIANT_OPTIONS) %>
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
-    def initialize(title:, scheme: nil, variant: nil, **system_arguments)
+    def initialize(tag: DEFAULT_TAG, title:, scheme: nil, variant: nil, **system_arguments)
       @system_arguments = system_arguments
-      @system_arguments[:tag] ||= :span
+      @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
       @system_arguments[:title] = title
       @system_arguments[:classes] = class_names(
         "Label",