primer_view_components 0.0.113 → 0.0.115

data/app/components/primer/beta/markdown.rb

@@ -0,0 +1,291 @@
+# frozen_string_literal: true
+
+module Primer
+  module Beta
+    # Use `Markdown` to wrap markdown content.
+    class Markdown < Primer::Component
+      warn_on_deprecated_slot_setter
+      status :beta
+
+      DEFAULT_TAG = :div
+      TAG_OPTIONS = [DEFAULT_TAG, :article, :td].freeze
+      # @example Default
+      #   <%= render(Primer::Beta::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>
+      #
+      #     <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>
+      #
+      #     <p>There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.</p>
+      #
+      #     <blockquote>
+      #       <p>There should be no margin above this first sentence.</p>
+      #       <p>Blockquotes should be a lighter gray with a gray border along the left side.</p>
+      #       <p>There should be no margin below this final sentence.</p>
+      #     </blockquote>
+      #
+      #     <h1>Header 1</h1>
+      #
+      #     <p>This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</p>
+      #
+      #     <h2>Header 2</h2>
+      #
+      #     <blockquote>This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.</blockquote>
+      #
+      #     <h3>Header 3</h3>
+      #
+      #     <pre><code>This is a code block following a header.</code></pre>
+      #
+      #     <h4>Header 4</h4>
+      #
+      #     <ul>
+      #       <li>This is an unordered list following a header.</li>
+      #       <li>This is an unordered list following a header.</li>
+      #       <li>This is an unordered list following a header.</li>
+      #     </ul>
+      #
+      #     <h5>Header 5</h5>
+      #
+      #     <ol>
+      #       <li>This is an ordered list following a header.</li>
+      #       <li>This is an ordered list following a header.</li>
+      #       <li>This is an ordered list following a header.</li>
+      #     </ol>
+      #
+      #     <h6>Header 6</h6>
+      #
+      #     <table>
+      #       <thead>
+      #         <tr>
+      #           <th>What</th>
+      #           <th>Follows</th>
+      #         </tr>
+      #       </thead>
+      #       <tbody>
+      #         <tr>
+      #           <td>A table</td>
+      #           <td>A header</td>
+      #         </tr>
+      #         <tr>
+      #           <td>A table</td>
+      #           <td>A header</td>
+      #         </tr>
+      #         <tr>
+      #           <td>A table</td>
+      #           <td>A header</td>
+      #         </tr>
+      #       </tbody>
+      #     </table>
+      #
+      #     <hr />
+      #
+      #     <p>There's a horizontal rule above and below this.</p>
+      #
+      #     <hr />
+      #
+      #     <p>Here is an unordered list:</p>
+      #
+      #     <ul>
+      #       <li>Salt-n-Pepa</li>
+      #       <li>Bel Biv DeVoe</li>
+      #       <li>Kid 'N Play</li>
+      #     </ul>
+      #
+      #     <p>And an ordered list:</p>
+      #
+      #     <ol>
+      #       <li>Michael Jackson</li>
+      #       <li>Michael Bolton</li>
+      #       <li>Michael Bublé</li>
+      #     </ol>
+      #
+      #     <p>And an unordered task list:</p>
+      #
+      #     <ul>
+      #       <li><input type="checkbox" id="create-markdown" checked /><label for="create-markdown">Create a sample markdown document</label><br></li>
+      #       <li><input type="checkbox" id="tasks-list" checked /><label for="tasks-list">Add tasks list to it</label><br></li>
+      #       <li><input type="checkbox" id="take-vacation" checked /><label for="take-vacation">Take a vacation</label><br></li>
+      #     </ul>
+      #
+      #     <p>And a "mixed" task list:</p>
+      #
+      #     <ul>
+      #       <li><input type="checkbox"id="steal-underpants"/><label for="steal-underpants">Steal underpants</label></li>
+      #       <li>?</li>
+      #       <li><input type="checkbox"id="profit"/><label for="profit">Profit!</label></li>
+      #     </ul>
+      #
+      #     And a nested list:
+      #
+      #     <ul>
+      #       <li>Jackson 5
+      #         <ul>
+      #           <li>Michael</li>
+      #           <li>Tito</li>
+      #           <li>Jackie</li>
+      #           <li>Marlon</li>
+      #           <li>Jermaine</li>
+      #         </ul>
+      #       </li>
+      #       <li>TMNT
+      #         <ul>
+      #           <li>Leonardo</li>
+      #           <li>Michelangelo</li>
+      #           <li>Donatello</li>
+      #           <li>Raphael</li>
+      #         </ul>
+      #       </li>
+      #     </ul>
+      #
+      #     <p>Definition lists can be used with HTML syntax. Definition terms are bold and italic.</p>
+      #
+      #     <dl>
+      #         <dt>Name</dt>
+      #         <dd>Godzilla</dd>
+      #         <dt>Born</dt>
+      #         <dd>1952</dd>
+      #         <dt>Birthplace</dt>
+      #         <dd>Japan</dd>
+      #         <dt>Color</dt>
+      #         <dd>Green</dd>
+      #     </dl>
+      #
+      #     <hr />
+      #
+      #     <p>Tables should have bold headings and alternating shaded rows.</p>
+      #
+      #     <table>
+      #       <thead>
+      #         <tr>
+      #           <th>Artist</th>
+      #           <th>Album</th>
+      #           <th>Year</th>
+      #         </tr>
+      #       </thead>
+      #       <tbody>
+      #         <tr>
+      #           <td>David Bowie</td>
+      #           <td>Scary Monsters</td>
+      #           <td>1980</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Prince</td>
+      #           <td>Purple Rain</td>
+      #           <td>1982</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Beastie Boys</td>
+      #           <td>License to Ill</td>
+      #           <td>1986</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Janet Jackson</td>
+      #           <td>Rhythm Nation 1814</td>
+      #           <td>1989</td>
+      #         </tr>
+      #       </tbody>
+      #     </table>
+      #
+      #     <p>If a table is too wide, it should condense down and/or scroll horizontally.</p>
+      #
+      #     <table>
+      #       <thead>
+      #         <tr>
+      #           <th>Artist</th>
+      #           <th>Album</th>
+      #           <th>Year</th>
+      #           <th>Label</th>
+      #           <th>Songs</th>
+      #         </tr>
+      #       </thead>
+      #       <tbody>
+      #         <tr>
+      #           <td>David Bowie</td>
+      #           <td>Scary Monsters</td>
+      #           <td>1980</td>
+      #           <td>RCA Records</td>
+      #           <td>It's No Game (No. 1), Up the Hill Backwards, Scary Monsters (And Super Creeps), Ashes to Ashes, Fashion, Teenage Wildlife, Scream Like a Baby, Kingdom Come, Because You're Young, It's No Game (No. 2)</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Prince</td>
+      #           <td>Purple Rain</td>
+      #           <td>1982</td>
+      #           <td>Warner Brothers Records</td>
+      #           <td>Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Beastie Boys</td>
+      #           <td>License to Ill</td>
+      #           <td>1986</td>
+      #           <td>Def Jam</td>
+      #           <td>Rhymin &amp; Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, Fight for Your Right, No Sleep till Brooklyn, Paul Revere, "Hold It Now, Hit It", Brass Monkey, Slow and Low, Time to Get Ill</td>
+      #         </tr>
+      #         <tr>
+      #           <td>Janet Jackson</td>
+      #           <td>Rhythm Nation 1814</td>
+      #           <td>1989</td>
+      #           <td>A&amp;M</td>
+      #           <td>Interlude: Pledge, Rhythm Nation, Interlude: T.V., State of the World, Interlude: Race, The Knowledge, Interlude: Let's Dance, Miss You Much, Interlude: Come Back, Love Will Never Do (Without You), Livin' in a World (They Didn't Make), Alright, Interlude: Hey Baby, Escapade, Interlude: No Acid, Black Cat, Lonely, Come Back to Me, Someday Is Tonight, Interlude: Livin'...In Complete Darkness</td>
+      #         </tr>
+      #       </tbody>
+      #     </table>
+      #
+      #     <hr />
+      #
+      #     <p>Code snippets like <code>var foo = "bar";</code> can be shown inline.</p>
+      #
+      #     <p>Also, <code>this should vertically align</code> <s><code>with this</code></s> <s>and this</s>.</p>
+      #
+      #     <p>Code can also be shown in a block element.</p>
+      #
+      #     <pre><code>var foo = "bar";</code></pre>
+      #
+      #     <p>Code can also use syntax highlighting.</p>
+      #
+      #     <pre><code>var foo = "bar";</code></pre>
+      #
+      #     <pre tabindex="0"><code>Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.</code></pre>
+      #
+      #     <pre tabindex="0"><code>var foo = "The same thing is true for code with syntax highlighting. A single line of code should horizontally scroll if it is really long.";</code></pre>
+      #
+      #     <p>Inline code inside table cells should still be distinguishable.</p>
+      #
+      #     <table>
+      #       <thead>
+      #         <tr>
+      #           <th>Language</th>
+      #           <th>Code</th>
+      #         </tr>
+      #       </thead>
+      #       <tbody>
+      #         <tr>
+      #           <td>JavasScript</td>
+      #           <td><code>var foo = "bar";</code></td>
+      #         </tr>
+      #         <tr>
+      #           <td>Ruby</td>
+      #           <td><code>foo = "bar"</code></td>
+      #         </tr>
+      #       </tbody>
+      #     </table>
+      #
+      #     <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::Beta::Markdown::TAG_OPTIONS) %>
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      def initialize(tag: DEFAULT_TAG, **system_arguments)
+        @system_arguments = system_arguments
+        @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
+
+        @system_arguments[:classes] = class_names(
+          "markdown-body",
+          system_arguments[:classes]
+        )
+      end
+
+      def call
+        render(Primer::BaseComponent.new(**@system_arguments)) { content }
+      end
+    end
+  end
+end

data/app/components/primer/beta/octicon.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "octicons"
+
+module Primer
+  module Beta
+    # `Octicon` renders an <%= link_to_octicons %> with <%= link_to_system_arguments_docs %>.
+    # `Octicon` can also be rendered with the `primer_octicon` helper, which accepts the same arguments.
+    class Octicon < Primer::Component
+      status :beta
+
+      SIZE_XSMALL = :xsmall
+      SIZE_DEFAULT = :small
+      SIZE_MEDIUM = :medium
+
+      SIZE_MAPPINGS = {
+        SIZE_XSMALL => 12,
+        SIZE_DEFAULT => 16,
+        SIZE_MEDIUM => 24
+      }.freeze
+      SIZE_OPTIONS = SIZE_MAPPINGS.keys
+
+      # @example Default
+      #   <%= render(Primer::Beta::Octicon.new(:check)) %>
+      #   <%= render(Primer::Beta::Octicon.new(icon: :check)) %>
+      #
+      # @example Medium
+      #   <%= render(Primer::Beta::Octicon.new(:people, size: :medium)) %>
+      #
+      # @example Helper
+      #   <%= primer_octicon(:check) %>
+      #
+      # @param icon_name [Symbol, String] Name of <%= link_to_octicons %> to use.
+      # @param icon [Symbol, String] Name of <%= link_to_octicons %> to use.
+      # @param size [Symbol] <%= one_of(Primer::Beta::Octicon::SIZE_MAPPINGS, sort: false) %>
+      # @param use_symbol [Boolean] EXPERIMENTAL (May change or be removed) - Set to true when using with <%= link_to_component(Primer::Alpha::OcticonSymbols) %>.
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      def initialize(icon_name = nil, icon: nil, size: SIZE_DEFAULT, use_symbol: false, **system_arguments)
+        icon_key = icon_name || icon
+
+        # Don't allow sizes under 16px
+        if system_arguments[:height].present? && system_arguments[:height].to_i < 16 || system_arguments[:width].present? && system_arguments[:width].to_i < 16
+          system_arguments.delete(:height)
+          system_arguments.delete(:width)
+        end
+
+        cache_key = Primer::Octicon::Cache.get_key(
+          symbol: icon_key,
+          size: size,
+          height: system_arguments[:height],
+          width: system_arguments[:width]
+        )
+
+        @system_arguments = system_arguments
+        @system_arguments[:tag] = :svg
+        @system_arguments[:aria] ||= {}
+        @use_symbol = use_symbol
+
+        if @system_arguments[:aria][:label] || @system_arguments[:"aria-label"]
+          @system_arguments[:role] = "img"
+        else
+          @system_arguments[:aria][:hidden] = true
+        end
+
+        if (cache_icon = Primer::Octicon::Cache.read(cache_key))
+          @icon = cache_icon
+        else
+          # Filter out classify options to prevent them from becoming invalid html attributes.
+          # Note height and width are both classify options and valid html attributes.
+          octicon_options = {
+            height: @system_arguments[:height] || SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, size, SIZE_DEFAULT)],
+            width: @system_arguments[:width]
+          }
+          octicon_options.compact!
+
+          @icon = Octicons::Octicon.new(icon_key, octicon_options)
+          Primer::Octicon::Cache.set(cache_key, @icon)
+        end
+
+        @system_arguments[:classes] = class_names(
+          @icon.options[:class],
+          @system_arguments[:classes]
+        )
+        @system_arguments.merge!(@icon.options.except(:class, :'aria-hidden'))
+      end
+    end
+  end
+end

data/app/components/primer/beta/relative_time.rb

@@ -4,6 +4,7 @@ module Primer
   module Beta
     # Formats a timestamp as a localized string or as relative text that auto-updates in the user's browser.
     class RelativeTime < Primer::Component
+      warn_on_deprecated_slot_setter
       status :beta
 
       TENSE_DEFAULT = :auto
@@ -101,7 +102,7 @@ module Primer
       # @param month [Symbol] What format months should take. <%= one_of(Primer::Beta::RelativeTime::MONTH_OPTIONS) %>
       # @param year [Symbol] What format years should take. <%= one_of(Primer::Beta::RelativeTime::YEAR_OPTIONS) %>
       # @param time_zone_name [Symbol] What format the time zone should take. <%= one_of(Primer::Beta::RelativeTime::TIMEZONENAME_OPTIONS) %>
-      # @param threshold [string] The threshold at which relative time displays become absolute.
+      # @param threshold [string] The threshold, in ISO-8601 'durations' format, at which relative time displays become absolute.
       # @param precision [Symbol] The precision elapsed time should display. <%= one_of(Primer::Beta::RelativeTime::PRECISION_OPTIONS) %>
       # @param format [Symbol] The format the display should take. <%= one_of(Primer::Beta::RelativeTime::FORMAT_OPTIONS) %>
       # @param lang [string] The language to use.

data/app/components/primer/beta/spinner.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Primer
+  module Beta
+    # Use `Spinner` to let users know that content is being loaded.
+    class Spinner < Primer::Component
+      warn_on_deprecated_slot_setter
+      status :beta
+
+      DEFAULT_SIZE = :medium
+      SIZE_MAPPINGS = {
+        :small => 16,
+        DEFAULT_SIZE => 32,
+        :large => 64
+      }.freeze
+      SIZE_OPTIONS = SIZE_MAPPINGS.keys
+      # Setting `box-sizing: content-box` allows consumers to add padding
+      # to the spinner without shrinking the icon
+      DEFAULT_STYLE = "box-sizing: content-box; color: var(--color-icon-primary);"
+
+      #
+      # @example Default
+      #   <%= render(Primer::Beta::Spinner.new) %>
+      #
+      # @example Small
+      #   <%= render(Primer::Beta::Spinner.new(size: :small)) %>
+      #
+      # @example Large
+      #   <%= render(Primer::Beta::Spinner.new(size: :large)) %>
+      #
+      # @param size [Symbol] <%= one_of(Primer::Beta::Spinner::SIZE_MAPPINGS) %>
+      # @param style [String] Custom element styles.
+      # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+      def initialize(size: DEFAULT_SIZE, style: DEFAULT_STYLE, **system_arguments)
+        @system_arguments = deny_tag_argument(**system_arguments)
+        @system_arguments[:tag] = :svg
+        @system_arguments[:style] ||= style
+        @system_arguments[:animation] = :rotate
+        @system_arguments[:width] = SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, size, DEFAULT_SIZE)]
+        @system_arguments[:height] = SIZE_MAPPINGS[fetch_or_fallback(SIZE_OPTIONS, size, DEFAULT_SIZE)]
+        @system_arguments[:viewBox] = "0 0 16 16"
+        @system_arguments[:fill] = :none
+      end
+    end
+  end
+end

data/app/components/primer/beta/text.rb

@@ -4,6 +4,7 @@ module Primer
   module Beta
     # `Text` is a wrapper component that will apply typography styles to the text inside.
     class Text < Primer::Component
+      warn_on_deprecated_slot_setter
       status :beta
 
       DEFAULT_TAG = :span

data/app/components/primer/blankslate_component.rb

@@ -10,10 +10,10 @@ module Primer
 
     # Optional Spinner.
     #
-    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::SpinnerComponent) %>.
+    # @param kwargs [Hash] The same arguments as <%= link_to_component(Primer::Beta::Spinner) %>.
     renders_one :spinner, lambda { |**system_arguments|
       system_arguments[:mb] ||= 3
-      Primer::SpinnerComponent.new(**system_arguments)
+      Primer::Beta::Spinner.new(**system_arguments)
     }
 
     #
@@ -95,7 +95,7 @@ module Primer
     # @param title [String] Text that appears in a larger bold font.
     # @param title_tag [Symbol] HTML tag to use for title.
     # @param icon [Symbol] Octicon icon to use at top of component.
-    # @param icon_size [Symbol] <%= one_of(Primer::OcticonComponent::SIZE_MAPPINGS, sort: false) %>
+    # @param icon_size [Symbol] <%= one_of(Primer::Beta::Octicon::SIZE_MAPPINGS, sort: false) %>
     # @param image_src [String] Image to display.
     # @param image_alt [String] Alt text for image.
     # @param description [String] Text that appears below the title. Typically a whole sentence.

data/app/components/primer/box.rb

@@ -3,6 +3,7 @@
 module Primer
   # `Box` is a basic wrapper component for most layout related needs.
   class Box < Primer::Component
+    warn_on_deprecated_slot_setter
     status :stable
 
     # @example Default

data/app/components/primer/button_component.rb

@@ -28,14 +28,14 @@ module Primer
     #
     # Use:
     #
-    # - `leading_visual_icon` for a <%= link_to_component(Primer::OcticonComponent) %>.
+    # - `leading_visual_icon` for a <%= link_to_component(Primer::Beta::Octicon) %>.
     #
-    # @param system_arguments [Hash] Same arguments as <%= link_to_component(Primer::OcticonComponent) %>.
+    # @param system_arguments [Hash] Same arguments as <%= link_to_component(Primer::Beta::Octicon) %>.
     renders_one :leading_visual, types: {
       icon: lambda { |**system_arguments|
         system_arguments[:mr] = 2
 
-        Primer::OcticonComponent.new(**system_arguments)
+        Primer::Beta::Octicon.new(**system_arguments)
       }
     }
     alias icon leading_visual_icon # remove alias when all buttons are migrated to new slot names

data/app/components/primer/conditional_wrapper.rb

@@ -22,6 +22,8 @@ module Primer
   # @param condition [Boolean] Whether or not to wrap the content in a `Primer::BaseComponent`.
   # @param base_component_arguments [Hash] The arguments to pass to `Primer::BaseComponent`.
   class ConditionalWrapper < Primer::Component
+    warn_on_deprecated_slot_setter
+
     def initialize(condition:, **base_component_arguments)
       @condition = condition
       @base_component_arguments = base_component_arguments

data/app/components/primer/hellip_button.rb

@@ -8,6 +8,8 @@ module Primer
   #   * This button is displaying a hellip as its content (The three dots character). Therefore a label is needed for screen readers.
   #   * Set the attribute `aria-label` on the system arguments. E.g. `Primer::HellipButton.new("aria-label": "Expand next part")`
   class HellipButton < Primer::Component
+    warn_on_deprecated_slot_setter
+
     # @example Default
     #   <%= render(Primer::HellipButton.new("aria-label": "No effect")) %>
     #

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

@@ -1,12 +1,12 @@
 <% if render_tooltip? %>
   <%= render Primer::BaseComponent.new(tag: :div, position: :relative, display: :inline_block) do %>
     <%= render Primer::Beta::BaseButton.new(**@system_arguments) do -%>
-      <%= render Primer::OcticonComponent.new(icon: @icon) %>
+      <%= render Primer::Beta::Octicon.new(icon: @icon) %>
     <% end -%>
     <%= render Primer::Alpha::Tooltip.new(**@tooltip_arguments) %>
   <% end %>
 <% else %>
   <%= render Primer::Beta::BaseButton.new(**@system_arguments) do -%>
-    <%= render Primer::OcticonComponent.new(icon: @icon) %>
+    <%= render Primer::Beta::Octicon.new(icon: @icon) %>
   <% end -%>
 <% end %>

data/app/components/primer/icon_button.rb

@@ -12,6 +12,7 @@ module Primer
   #   Either `aria-label` or `aria-description` will be used for the `Tooltip` text, depending on which one is present.
   #   [Learn more about best functional image practices (WAI Images)](https://www.w3.org/WAI/tutorials/images/functional)
   class IconButton < Primer::Component
+    warn_on_deprecated_slot_setter
     status :deprecated
 
     DEFAULT_SCHEME = :default

data/app/components/primer/layout_component.rb

@@ -3,6 +3,8 @@
 module Primer
   # Use `Layout` to build a main/sidebar layout.
   class LayoutComponent < Primer::Component
+    warn_on_deprecated_slot_setter
+
     # The main content
     #
     # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>

data/app/components/primer/local_time.rb

@@ -3,6 +3,9 @@
 module Primer
   # Use `LocalTime` to format a date and time in the user's preferred locale format. This component requires JavaScript.
   class LocalTime < Primer::Component
+    warn_on_deprecated_slot_setter
+    status :deprecated
+
     DEFAULT_DIGIT_TYPE = :numeric
     DIGIT_TYPE_OPTIONS = [DEFAULT_DIGIT_TYPE, :"2-digit"].freeze