primer_view_components 0.0.17 → 0.0.22

data/app/components/primer/flex_item_component.rb

@@ -1,10 +1,25 @@
 # frozen_string_literal: true
 
 module Primer
+  # Use FlexItemComponent to specify the ability of a flex item to alter its
+  # dimensions to fill available space
   class FlexItemComponent < Primer::Component
     FLEX_AUTO_DEFAULT = false
-    FLEX_AUTO_ALLOWED_VALUES = [FLEX_AUTO_DEFAULT, true]
+    FLEX_AUTO_ALLOWED_VALUES = [FLEX_AUTO_DEFAULT, true].freeze
 
+    # @example Default
+    #   <%= render(Primer::FlexComponent.new) do %>
+    #     <%= render(Primer::FlexItemComponent.new) do %>
+    #       Item 1
+    #     <% end %>
+    #
+    #     <%= render(Primer::FlexItemComponent.new(flex_auto: true)) do %>
+    #       Item 2
+    #     <% end %>
+    #   <% end %>
+    #
+    # @param flex_auto [Boolean] Fills available space and auto-sizes based on the content. Defaults to <%= Primer::FlexItemComponent::FLEX_AUTO_DEFAULT %>
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(flex_auto: FLEX_AUTO_DEFAULT, **system_arguments)
       @system_arguments = system_arguments
       @system_arguments[:classes] =

data/app/components/primer/heading_component.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
 module Primer
+  # Use the Heading component to wrap a component that will create a heading element
   class HeadingComponent < Primer::Component
+    view_helper :heading
+
+    # @example Default
+    #   <%= render(Primer::HeadingComponent.new) { "H1 Text" } %>
+    #   <%= render(Primer::HeadingComponent.new(tag: :h2)) { "H2 Text" } %>
+    #   <%= render(Primer::HeadingComponent.new(tag: :h3)) { "H3 Text" } %>
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
     def initialize(**system_arguments)
       @system_arguments = system_arguments
       @system_arguments[:tag] ||= :h1

data/app/components/primer/label_component.rb

@@ -9,8 +9,8 @@ module Primer
       info: "Label--info",
       success: "Label--success",
       warning: "Label--warning",
-      danger: "Label--danger",
-    }
+      danger: "Label--danger"
+    }.freeze
 
     DEPRECATED_SCHEME_MAPPINGS = {
       gray: "Label--gray",
@@ -23,7 +23,7 @@ module Primer
       purple: "Label--purple",
       pink: "Label--pink",
       outline: "Label--outline",
-      green_outline: "Label--outline-green",
+      green_outline: "Label--outline-green"
     }.freeze
 
     SCHEME_MAPPINGS = NEW_SCHEME_MAPPINGS.merge(DEPRECATED_SCHEME_MAPPINGS)
@@ -31,11 +31,11 @@ module Primer
 
     VARIANT_MAPPINGS = {
       large: "Label--large",
-      inline: "Label--inline",
+      inline: "Label--inline"
     }.freeze
     VARIANT_OPTIONS = VARIANT_MAPPINGS.keys << nil
 
-    # @example 40|Schemes
+    # @example Schemes
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label")) { "default" } %>
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", scheme: :gray)) { "gray" } %>
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", scheme: :dark_gray)) { "dark_gray" } %>
@@ -43,7 +43,7 @@ module Primer
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", scheme: :green)) { "green" } %>
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", scheme: :purple)) { "purple" } %>
     #
-    # @example 40|Variants
+    # @example Variants
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label")) { "Default" } %>
     #   <%= render(Primer::LabelComponent.new(title: "Label: Label", variant: :large)) { "Large" } %>
     #

data/app/components/primer/layout_component.rb

@@ -12,13 +12,13 @@ module Primer
     DEFAULT_SIDEBAR_COL = 3
     ALLOWED_SIDEBAR_COLS = (1..(MAX_COL - 1)).to_a.freeze
 
-    # @example 40|Default
+    # @example Default
     #   <%= render(Primer::LayoutComponent.new) do |component| %>
     #     <% component.with(:sidebar) { "Sidebar" } %>
     #     <% component.with(:main) { "Main" } %>
     #   <% end %>
     #
-    # @example 40|Left sidebar
+    # @example Left sidebar
     #   <%= render(Primer::LayoutComponent.new(side: :left)) do |component| %>
     #     <% component.with(:sidebar) { "Sidebar" } %>
     #     <% component.with(:main) { "Main" } %>

data/app/components/primer/link_component.rb

@@ -3,10 +3,10 @@
 module Primer
   # Use links for moving from one page to another. The Link component styles anchor tags with default blue styling and hover text-decoration.
   class LinkComponent < Primer::Component
-    # @example 40|Default
+    # @example Default
     #   <%= render(Primer::LinkComponent.new(href: "http://www.google.com")) { "Link" } %>
     #
-    # @example 40|Muted
+    # @example Muted
     #   <%= render(Primer::LinkComponent.new(href: "http://www.google.com", muted: true)) { "Link" } %>
     #
     # @param href [String] URL to be used for the Link
@@ -25,5 +25,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/markdown_component.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use MarkdownComponent to wrap markdown content
+  class MarkdownComponent < Primer::Component
+    # @example Default
+    #   <%= render(Primer::MarkdownComponent.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 Buble</li>
+    #     </ol>
+    #
+    #     <p>And an unordered task list:</p>
+    #
+    #     <ul>
+    #       <li><input type="checkbox" checked /> Create a sample markdown document</li>
+    #       <li><input type="checkbox"/> Add task lists to it</li>
+    #       <li><input type="checkbox"/> Take a vacation</li>
+    #     </ul>
+    #
+    #     <p>And a "mixed" task list:</p>
+    #
+    #     <ul>
+    #       <li><input type="checkbox"/> Steal underpants</li>
+    #       <li>?</li>
+    #       <li><input type="checkbox"/> Profit!</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 class="prism-code language-javascript">var foo = "bar";</code></pre>
+    #
+    #     <pre><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><code class="prism-code language-javascript">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>
+    #
+    #     <hr />
+    #
+    #     <p>Small images should be shown at their actual size.</p>
+    #
+    #     <p><img src="http://placekitten.com/g/300/200/"/></p>
+    #
+    #     <p>Large images should always scale down and fit in the content container.</p>
+    #
+    #     <p><img src="http://placekitten.com/g/1200/800/"/></p>
+    #
+    #     <pre><code>This is the final element on the page and there should be no margin below this.</code></pre>
+    #   <% 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(
+        "markdown-body",
+        system_arguments[:classes]
+      )
+    end
+
+    def call
+      render(Primer::BaseComponent.new(**@system_arguments)) { content }
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+<%= render(Primer::BaseComponent.new(**@system_arguments)) do %>
+  <%= heading %>
+  <% items.each do |item| %>
+    <%= item %>
+  <% end %>
+<% end %>

data/app/components/primer/menu_component.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Primer
+  # Use menus to create vertical lists of navigational links.
+  class MenuComponent < Primer::Component
+    include ViewComponent::SlotableV2
+
+    # Optional menu heading
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_one :heading, lambda { |**system_arguments|
+      system_arguments[:tag] ||= :span
+      system_arguments[:classes] = class_names(
+        "menu-heading",
+        system_arguments[:classes]
+      )
+
+      Primer::BaseComponent.new(**system_arguments)
+    }
+
+    # Required list of navigational links
+    #
+    # @param href [String] URL to be used for the Link
+    # @param selected [Boolean] Whether the item is the current selection
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    renders_many :items, lambda { |href:, selected: false, **system_arguments|
+      system_arguments[:tag] = :a
+      system_arguments[:href] = href
+      system_arguments[:"aria-current"] = :page if selected
+      system_arguments[:classes] = class_names(
+        "menu-item",
+        system_arguments[:classes]
+      )
+
+      Primer::BaseComponent.new(**system_arguments)
+    }
+
+    # @example Default
+    #   <%= render(Primer::MenuComponent.new) do |c| %>
+    #     <% c.heading do %>
+    #       Heading
+    #     <% end %>
+    #     <% c.item(selected: true, href: "#url") do %>
+    #       Item 1
+    #     <% end %>
+    #     <% c.item(href: "#url") do %>
+    #       <%= render(Primer::OcticonComponent.new(icon: "check")) %>
+    #       With Icon
+    #     <% end %>
+    #     <% c.item(href: "#url") do %>
+    #       <%= render(Primer::OcticonComponent.new(icon: "check")) %>
+    #       With Icon and Counter
+    #       <%= render(Primer::CounterComponent.new(count: 25)) %>
+    #     <% end %>
+    #   <% end %>
+    #
+    # @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
+    def initialize(**system_arguments)
+      @system_arguments = system_arguments
+      @system_arguments[:tag] = :nav
+      @system_arguments[:classes] = class_names(
+        "menu",
+        @system_arguments[:classes]
+      )
+    end
+
+    def render?
+      items.any?
+    end
+  end
+end