primer_view_components 0.0.97 → 0.0.98

data/previews/primer/forms/forms_preview/single_text_field_form.html.erb

@@ -0,0 +1,3 @@
+<%= primer_form_with(url: "/foo") do |f| %>
+  <%= render(SingleTextFieldForm.new(f)) %>
+<% end %>

data/previews/primer/forms/forms_preview/submit_button_form.html.erb

@@ -0,0 +1,3 @@
+<%= primer_form_with(url: "/foo") do |f| %>
+  <%= render(SubmitButtonForm.new(f)) %>
+<% end %>

data/previews/primer/forms/forms_preview/text_field_and_checkbox_form.html.erb

@@ -0,0 +1,3 @@
+<%= primer_form_with(url: "/foo") do |f| %>
+  <%= render(TextFieldAndCheckboxForm.new(f)) %>
+<% end %>

data/previews/primer/forms/forms_preview.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Primer
+  module Forms
+    class FormsPreview < ViewComponent::Preview
+      def single_text_field_form; end
+
+      def multi_text_field_form; end
+
+      def text_field_and_checkbox_form; end
+
+      def horizontal_form; end
+
+      def composed_form; end
+
+      def submit_button_form; end
+
+      def radio_button_group_form; end
+
+      def check_box_group_form; end
+
+      def array_check_box_group_form; end
+
+      def select_list_form; end
+
+      def radio_button_with_nested_form; end
+
+      def caption_template_form; end
+
+      def after_content_form; end
+
+      def invalid_form; end
+
+      def multi_input_form; end
+    end
+  end
+end

data/previews/primer/hellip_button_preview.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label HellipButton
+  class HellipButtonPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param aria_label [String]
+    # @param inline [Boolean]
+    def default(inline: false, aria_label: "No effect")
+      render(Primer::HellipButton.new(inline: inline, "aria-label": aria_label))
+    end
+  end
+end

data/previews/primer/image_crop_preview.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label ImageCrop
+  class ImageCropPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param rounded [Boolean]
+    def default(rounded: false)
+      render(Primer::ImageCrop.new(src: Primer::ExampleImage::BASE64_SRC, rounded: rounded))
+    end
+
+    # @label Custom loading slot
+    #
+    # @param rounded [Boolean]
+    def loading(rounded: false)
+      render(Primer::ImageCrop.new(src: Primer::ExampleImage::BASE64_SRC, rounded: rounded)) do |c|
+        c.with_loading { "Loading..." }
+      end
+    end
+end
+end

data/previews/primer/label_component_preview.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label LabelComponent
+  class LabelComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param size [Symbol] select [medium, large]
+    # @param tag [Symbol] select [span, summary, a, div]
+    # @param inline [Boolean] toggle
+    def default(size: :medium, tag: :span, inline: false)
+      render(Primer::LabelComponent.new(tag: tag, size: size, inline: inline)) { "Label" }
+    end
+  end
+end

data/previews/primer/layout_component_preview.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label LayoutComponent
+  class LayoutComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param responsive [Boolean]
+    # @param side [Symbol] select [left, right]
+    # @param sidebar_col [Integer] select [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+    def default(responsive: false, side: :right, sidebar_col: 3)
+      render(Primer::LayoutComponent.new(responsive: responsive, side: side, sidebar_col: sidebar_col)) do |component|
+        component.with_main { "Main" }
+        component.with_sidebar { "Sidebar" }
+      end
+    end
+  end
+end

data/previews/primer/link_component_preview.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label LinkComponent
+  class LinkComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param underline [Boolean]
+    # @param muted [Boolean]
+    # @param tag [Symbol] select [a, span]
+    # @param scheme [Symbol] select [default, primary, secondary]
+    def default(tag: :a, scheme: :default, muted: false, underline: true)
+      render(Primer::LinkComponent.new(href: "#", tag: tag, scheme: scheme, muted: muted, underline: underline)) { "This is a link!" }
+    end
+
+    # @label with Tooltip
+    #
+    # @param underline [Boolean]
+    # @param muted [Boolean]
+    # @param tag [Symbol] select [a, span]
+    # @param scheme [Symbol] select [default, primary, secondary]
+    def tooltip(tag: :a, scheme: :default, muted: false, underline: true)
+      render(Primer::LinkComponent.new(href: "#", id: "tooltip-link", tag: tag, scheme: scheme, muted: muted, underline: underline)) do |component|
+        component.with_tooltip(text: "Tooltip text")
+        "Link with tooltip"
+      end
+    end
+  end
+end

data/previews/primer/local_time_component_preview.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label LocalTime
+  class LocalTimeComponentPreview < ViewComponent::Preview
+    # @param datetime datetime-local
+    # @param weekday [Symbol] select [long, short]
+    # @param month [Symbol] select [long, short]
+    # @param year [Symbol] select [numeric, "2-digit"]
+    # @param day [Symbol] select [numeric, "2-digit"]
+    # @param hour [Symbol] select [numeric, "2-digit"]
+    # @param minute [Symbol] select [numeric, "2-digit"]
+    # @param second [Symbol] select [numeric, "2-digit"]
+    # @param time_zone_name [Symbol] select [long, short]
+    def default(datetime: "2014-04-01T16:30:00-08:00", weekday: :short, month: :short, year: :numeric, day: :numeric, hour: :numeric, minute: :numeric, second: :numeric, time_zone_name: :short)
+      render(Primer::LocalTime.new(datetime: DateTime.parse(datetime), weekday: weekday, month: month, year: year, day: day, hour: hour, minute: minute, second: second, time_zone_name: time_zone_name))
+    end
+
+    # @hidden
+    def with_all_the_options
+      render(Primer::LocalTime.new(
+               datetime: DateTime.parse("2016-06-01T13:05:07Z"),
+               weekday: :long,
+               year: :"2-digit",
+               month: :long,
+               day: :"2-digit",
+               hour: :"2-digit",
+               minute: :"2-digit",
+               second: :"2-digit",
+               time_zone_name: :long
+             ))
+    end
+
+    # @label With replaceable content
+    #
+    # @param initial_text [String] textarea
+    def with_contents(initial_text: "This will be replaced")
+      render Primer::LocalTime.new(datetime: DateTime.parse("2014-04-01T16:30:00-08:00"), initial_text: initial_text)
+    end
+  end
+end

data/previews/primer/markdown_preview.rb

@@ -0,0 +1,280 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label Markdown
+  class MarkdownPreview < ViewComponent::Preview
+    # @label Default Options
+    def 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>
+
+        <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\" 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>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>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>Large images should always scale down and fit in the content container.</p>
+
+        <!-- p><img src=\"http://placekitten.com/g/1200/800/\"></!-->
+
+        <pre><code>This is the final element on the page and there should be no margin below this.</code></pre>".html_safe # rubocop:disable Rails/OutputSafety
+      end
+    end
+  end
+end

data/previews/primer/menu_component_preview/default.html.erb

@@ -0,0 +1,17 @@
+<%= render(Primer::MenuComponent.new) do |c| %>
+  <% c.with_heading(tag: :h2) do %>
+    Heading
+  <% end %>
+  <% c.with_item(selected: true, href: "#url") do %>
+    Item 1
+  <% end %>
+  <% c.with_item(href: "#url") do %>
+    <%= render(Primer::OcticonComponent.new("check")) %>
+    With Icon
+  <% end %>
+  <% c.with_item(href: "#url") do %>
+    <%= render(Primer::OcticonComponent.new("check")) %>
+    With Icon and Counter
+    <%= render(Primer::Beta::Counter.new(count: 25)) %>
+  <% end %>
+<% end %>

data/previews/primer/menu_component_preview.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label MenuComponent
+  class MenuComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    def default; end
+  end
+end

data/previews/primer/octicon_component_preview.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label OcticonComponent
+  class OcticonComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param aria_label [String]
+    # @param size [Symbol] select [xsmall, small, medium]
+    def default(size: :small, aria_label: nil)
+      render(Primer::OcticonComponent.new(icon: :people, size: size, "aria-label": aria_label))
+    end
+  end
+end

data/previews/primer/popover_component_preview.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label PopoverComponent
+  class PopoverComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param caret [Symbol] select [top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, left_bottom, left_top, right_bottom, right_top]
+    def default(caret: :top)
+      render Primer::PopoverComponent.new do |component|
+        component.with_heading do
+          "Activity feed"
+        end
+        component.with_body(caret: caret) do
+          "This is the Popover body."
+        end
+      end
+    end
+  end
+end

data/previews/primer/progress_bar_component_preview.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label ProgressBarComponent
+  class ProgressBarComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param size [Symbol] select [default, small, large]
+    def default(size: :default)
+      render(Primer::ProgressBarComponent.new(size: size)) do |component|
+        component.with_item(percentage: 10)
+        component.with_item(bg: :accent_emphasis, percentage: 20)
+        component.with_item(bg: :danger_emphasis, percentage: 30)
+      end
+    end
+  end
+end

data/previews/primer/spinner_component_preview.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label SpinnerComponent
+  class SpinnerComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param size [Symbol] select [small, medium, large]
+    def default(size: :medium)
+      render(Primer::SpinnerComponent.new(size: size))
+    end
+  end
+end

data/previews/primer/state_component_preview.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label StateComponent
+  class StateComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param title [String]
+    # @param tag [Symbol] select [span, div]
+    # @param size [Symbol] select [default, small]
+    # @param scheme [Symbol] select [default, open, closed, merged]
+    def default(title: "State", scheme: :default, size: :default, tag: :span)
+      render(Primer::StateComponent.new(title: title, scheme: scheme, size: size, tag: tag)) { "State" }
+    end
+  end
+end

data/previews/primer/subhead_component_preview.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label SubheadComponent
+  class SubheadComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param spacious [Boolean]
+    # @param hide_border [Boolean]
+    # @param heading_danger [Boolean]
+    # @param heading_tag [Symbol] select [div, h1, h2, h3, h4, h5, h6]
+    def default(spacious: false, hide_border: false, heading_tag: :div, heading_danger: false)
+      render(Primer::SubheadComponent.new(spacious: spacious, hide_border: hide_border)) do |component|
+        component.with_heading(tag: heading_tag, danger: heading_danger) do
+          "My Heading"
+        end
+        component.with_description do
+          "My Description"
+        end
+      end
+    end
+  end
+end

data/previews/primer/time_ago_component_preview.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label TimeAgoComponent
+  class TimeAgoComponentPreview < ViewComponent::Preview
+    # @param time datetime-local
+    # @param micro [Boolean] toggle
+    def default(time: Time.zone.now.to_s, micro: false)
+      render(Primer::TimeAgoComponent.new(time: DateTime.parse(time), micro: micro))
+    end
+
+    def micro
+      render(Primer::TimeAgoComponent.new(time: Time.zone.now, micro: true))
+    end
+  end
+end

data/previews/primer/timeline_item_component_preview.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Primer
+  # @label TimelineItemComponent
+  class TimelineItemComponentPreview < ViewComponent::Preview
+    # @label Default Options
+    #
+    # @param condensed [Boolean]
+    def default(condensed: false)
+      render(Primer::TimelineItemComponent.new(condensed: condensed)) do |component|
+        component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "octocat")
+        component.with_badge(bg: :success_emphasis, color: :on_emphasis, icon: :check)
+        component.with_body { "Success!" }
+      end
+    end
+  end
+end

data/static/statuses.json

@@ -49,7 +49,7 @@
   "Primer::BlankslateComponent": "deprecated",
   "Primer::Box": "stable",
   "Primer::BoxComponent": "deprecated",
-  "Primer::ButtonComponent": "deprecated",
+  "Primer::ButtonComponent": "beta",
   "Primer::ClipboardCopy": "beta",
   "Primer::CloseButton": "deprecated",
   "Primer::ConditionalWrapper": "alpha",