primer_view_components 0.3.0 → 0.4.0

data/previews/primer/beta/counter_preview.rb

@@ -16,11 +16,13 @@ module Primer
       end
 
       # @label Default Options
+      # @snapshot
       def default
         render(Primer::Beta::Counter.new(count: 1_000))
       end
 
       # @label With Text
+      # @snapshot
       def with_text
         render(Primer::Beta::Counter.new(text: "∞"))
       end
@@ -28,16 +30,19 @@ module Primer
       # @!group Color Schemes
       #
       # @label Default
+      # @snapshot
       def color_scheme_default
         render(Primer::Beta::Counter.new(count: 1_000))
       end
 
       # @label Primary
+      # @snapshot
       def color_scheme_primary
         render(Primer::Beta::Counter.new(count: 1_000, scheme: :primary))
       end
 
       # @label Secondary
+      # @snapshot
       def color_scheme_secondary
         render(Primer::Beta::Counter.new(count: 1_000, scheme: :secondary))
       end
@@ -47,31 +52,37 @@ module Primer
       # @!group Rounded Number
       #
       # @label Default (No Rounding)
+      # @snapshot
       def rounding_default
         render(Primer::Beta::Counter.new(count: 1_234))
       end
 
       # @label Rounded Above 1,000
+      # @snapshot
       def rounding_above_1000
         render(Primer::Beta::Counter.new(count: 1_234, round: true))
       end
 
       # @label Rounded Below 1,000
+      # @snapshot
       def rounding_below_1000
         render(Primer::Beta::Counter.new(count: 999, round: true))
       end
 
       # @label Rounded Large Numbers w/ Default Limit
+      # @snapshot
       def rounding_large_number
         render(Primer::Beta::Counter.new(count: 4_567_890, round: true))
       end
 
       # @label Rounded Large Numbers, Less Than Custom Limit
+      # @snapshot
       def rounding_large_number_less_than_custom_limit
         render(Primer::Beta::Counter.new(count: 4_567_890, limit: 1_000_000_000, round: true))
       end
 
       # @label Rounded Large Numbers, Greater Than Custom Limit
+      # @snapshot
       def rounding_large_number_greater_than_custom_limit
         render(Primer::Beta::Counter.new(count: 4_567_890, limit: 1_000_000, round: true))
       end

data/previews/primer/beta/flash_preview.rb

@@ -17,6 +17,7 @@ module Primer
       end
 
       # @label Default
+      # @snapshot
       #
       def default
         render(Primer::Beta::Flash.new) { "This is a flash message!" }
@@ -25,21 +26,25 @@ module Primer
       # @!group Color Schemes
       #
       # @label Default
+      # @snapshot
       def color_scheme_default
         render(Primer::Beta::Flash.new) { "This is a flash message!" }
       end
 
       # @label Warning
+      # @snapshot
       def color_scheme_warning
         render(Primer::Beta::Flash.new(scheme: :warning)) { "This is a warning flash message!" }
       end
 
       # @label Danger
+      # @snapshot
       def color_scheme_danger
         render(Primer::Beta::Flash.new(scheme: :danger)) { "This is a danger flash message!" }
       end
 
       # @label Success
+      # @snapshot
       def color_scheme_success
         render(Primer::Beta::Flash.new(scheme: :success)) { "This is a success flash message!" }
       end
@@ -49,16 +54,19 @@ module Primer
       # @!group More options
       #
       # @label Full width
+      # @snapshot
       def options_full
         render(Primer::Beta::Flash.new(full: true)) { "This is a full width flash message!" }
       end
 
       # @label Dismissible
+      # @snapshot
       def options_dismissible
         render(Primer::Beta::Flash.new(dismissible: true)) { "This is a dismissible flash message!" }
       end
 
       # @label With icon
+      # @snapshot
       def options_with_icon
         render(Primer::Beta::Flash.new(icon: :info)) { "This is a flash message with an icon!" }
       end

data/previews/primer/beta/heading_preview.rb

@@ -16,6 +16,7 @@ module Primer
       #
       # @param tag [Symbol] select [h1, h2, h3, h4, h5, h6]
       # @param content [String] text
+      # @snapshot
       def default(tag: :h2, content: "Heading")
         render(Primer::Beta::Heading.new(tag: tag)) { content }
       end

data/previews/primer/beta/icon_button_preview.rb

@@ -39,6 +39,7 @@ module Primer
       # @param aria_label text
       # @param disabled toggle
       # @param tag select [a, summary, button]
+      # @snapshot
       def default(
         size: :medium,
         id: "button-preview",
@@ -63,6 +64,7 @@ module Primer
       # @param aria_label text
       # @param disabled toggle
       # @param tag select [a, summary, button]
+      # @snapshot
       def invisible(
         size: :medium,
         id: "button-preview",
@@ -87,6 +89,7 @@ module Primer
       # @param aria_label text
       # @param disabled toggle
       # @param tag select [a, summary, button]
+      # @snapshot
       def danger(
         size: :medium,
         id: "button-preview",

data/previews/primer/beta/label_preview.rb

@@ -14,6 +14,7 @@ module Primer
       end
 
       # @label Default Options
+      # @snapshot
       def default
         render(Primer::Beta::Label.new) { "Label" }
       end
@@ -26,46 +27,55 @@ module Primer
       end
 
       # @label Primary
+      # @snapshot
       def color_scheme_primary
         render(Primer::Beta::Label.new(scheme: :primary)) { "Primary" }
       end
 
       # @label Secondary
+      # @snapshot
       def color_scheme_secondary
         render(Primer::Beta::Label.new(scheme: :secondary)) { "Secondary" }
       end
 
       # @label Accent
+      # @snapshot
       def color_scheme_accent
         render(Primer::Beta::Label.new(scheme: :accent)) { "Accent" }
       end
 
       # @label Success
+      # @snapshot
       def color_scheme_success
         render(Primer::Beta::Label.new(scheme: :success)) { "Success" }
       end
 
       # @label Attention
+      # @snapshot
       def color_scheme_attention
         render(Primer::Beta::Label.new(scheme: :attention)) { "Attention" }
       end
 
       # @label Danger
+      # @snapshot
       def color_scheme_danger
         render(Primer::Beta::Label.new(scheme: :danger)) { "Danger" }
       end
 
       # @label Severe
+      # @snapshot
       def color_scheme_severe
         render(Primer::Beta::Label.new(scheme: :severe)) { "Severe" }
       end
 
       # @label Done
+      # @snapshot
       def color_scheme_done
         render(Primer::Beta::Label.new(scheme: :done)) { "Done" }
       end
 
       # @label Sponsors
+      # @snapshot
       def color_scheme_sponsors
         render(Primer::Beta::Label.new(scheme: :sponsors)) { "Sponsors" }
       end
@@ -75,11 +85,13 @@ module Primer
       # @!group Sizes
       #
       # @label Default
+      # @snapshot
       def size_default
         render(Primer::Beta::Label.new) { "Default" }
       end
 
       # @label Large
+      # @snapshot
       def size_large
         render(Primer::Beta::Label.new(size: :large)) { "Large" }
       end
@@ -94,6 +106,7 @@ module Primer
       end
 
       # @label Inline
+      # @snapshot
       def inline_inline
         render(Primer::Beta::Label.new(inline: true)) { "Inline" }
       end

data/previews/primer/beta/link_preview.rb

@@ -8,30 +8,28 @@ module Primer
       #
       # @param underline [Boolean]
       # @param muted [Boolean]
-      # @param tag [Symbol] select [a, span]
       # @param scheme [Symbol] select [default, primary, secondary]
-      def playground(tag: :a, scheme: :default, muted: false, underline: true)
-        render(Primer::Beta::Link.new(href: "#", tag: tag, scheme: scheme, muted: muted, underline: underline)) { "This is a link!" }
+      def playground(scheme: :default, muted: false, underline: true)
+        render(Primer::Beta::Link.new(href: "#", scheme: scheme, muted: muted, underline: underline)) { "This is a link!" }
       end
 
       # @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::Beta::Link.new(href: "#", tag: tag, scheme: scheme, muted: muted, underline: underline)) { "This is a link!" }
+      # @snapshot
+      def default(scheme: :default, muted: false, underline: true)
+        render(Primer::Beta::Link.new(href: "#", 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::Beta::Link.new(href: "#", id: "tooltip-link", tag: tag, scheme: scheme, muted: muted, underline: underline)) do |component|
+      def tooltip(scheme: :default, muted: false, underline: true)
+        render(Primer::Beta::Link.new(href: "#", id: "tooltip-link", scheme: scheme, muted: muted, underline: underline)) do |component|
           component.with_tooltip(text: "Tooltip text")
           "Link with tooltip"
         end
@@ -45,21 +43,25 @@ module Primer
       end
 
       # @label Primary
+      # @snapshot
       def color_scheme_primary
         render(Primer::Beta::Link.new(href: "#", scheme: :primary)) { "This is a primary link color." }
       end
 
       # @label Primary, Muted
+      # @snapshot
       def color_scheme_primary_muted
         render(Primer::Beta::Link.new(href: "#", scheme: :primary, muted: true)) { "This is a muted primary link color." }
       end
 
       # @label Secondary
+      # @snapshot
       def color_scheme_secondary
         render(Primer::Beta::Link.new(href: "#", scheme: :secondary)) { "This is a secondary link color." }
       end
 
       # @label Secondary, Muted
+      # @snapshot
       def color_scheme_secondary_muted
         render(Primer::Beta::Link.new(href: "#", scheme: :secondary, muted: true)) { "This is a muted secondary link color." }
       end

data/previews/primer/beta/markdown_preview.rb

@@ -283,6 +283,7 @@ module Primer
       end
 
       # @label Default Options
+      # @snapshot
       def default
         render(Primer::Beta::Markdown.new) do
           MD_FIXTURE

data/previews/primer/beta/octicon_preview.rb

@@ -16,6 +16,7 @@ module Primer
       #
       # @param aria_label [String]
       # @param size [Symbol] select [xsmall, small, medium]
+      # @snapshot
       def default(size: :small, aria_label: nil)
         render(Primer::Beta::Octicon.new(icon: :people, size: size, "aria-label": aria_label))
       end

data/previews/primer/beta/popover_preview.rb

@@ -21,6 +21,7 @@ module Primer
       # @label Default
       #
       # @param caret [Symbol] select [top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, left_bottom, left_top, right_bottom, right_top]
+      # @snapshot
       def default(caret: :top)
         render Primer::Beta::Popover.new do |component|
           component.with_heading do
@@ -33,6 +34,7 @@ module Primer
       end
 
       # @label Large
+      # @snapshot
       def large
         render Primer::Beta::Popover.new do |component|
           component.with_body(large: true) do
@@ -42,6 +44,7 @@ module Primer
       end
 
       # @!group Directions
+      # @snapshot
       def bottom_right
         render Primer::Beta::Popover.new do |component|
           component.with_body(caret: :bottom_right) do
@@ -50,6 +53,7 @@ module Primer
         end
       end
 
+      # @snapshot
       def top_right
         render Primer::Beta::Popover.new do |component|
           component.with_body(caret: :top_right) do
@@ -58,6 +62,7 @@ module Primer
         end
       end
 
+      # @snapshot
       def bottom_left
         render Primer::Beta::Popover.new do |component|
           component.with_body(caret: :bottom_left) do
@@ -66,6 +71,7 @@ module Primer
         end
       end
 
+      # @snapshot
       def top_left
         render Primer::Beta::Popover.new do |component|
           component.with_body(caret: :top_left) do

data/previews/primer/beta/progress_bar_preview.rb

@@ -18,6 +18,7 @@ module Primer
       # @label Default
       #
       # @param size [Symbol] select [default, small, large]
+      # @snapshot
       def default(size: :default)
         render(Primer::Beta::ProgressBar.new(size: size)) do |component|
           component.with_item(percentage: 10)
@@ -29,6 +30,7 @@ module Primer
       # @!group Sizes
       #
       # @label Size small
+      # @snapshot
       def size_small
         render(Primer::Beta::ProgressBar.new(size: :small)) do |component|
           component.with_item(percentage: 10)
@@ -38,6 +40,7 @@ module Primer
       end
 
       # @label Size default
+      # @snapshot
       def size_default
         render(Primer::Beta::ProgressBar.new(size: :default)) do |component|
           component.with_item(percentage: 10)
@@ -47,6 +50,7 @@ module Primer
       end
 
       # @label Size large
+      # @snapshot
       def size_large
         render(Primer::Beta::ProgressBar.new(size: :large)) do |component|
           component.with_item(percentage: 10)

data/previews/primer/beta/spinner_preview.rb

@@ -14,6 +14,7 @@ module Primer
       # @label Default Options
       #
       # @param size [Symbol] select [small, medium, large]
+      # @snapshot
       def default(size: :medium)
         render(Primer::Beta::Spinner.new(size: size))
       end

data/previews/primer/beta/state_preview.rb

@@ -20,6 +20,7 @@ module Primer
       # @param tag [Symbol] select [span, div]
       # @param size [Symbol] select [default, small]
       # @param scheme [Symbol] select [default, open, closed, merged]
+      # @snapshot
       def default(title: "State", scheme: :default, size: :default, tag: :span)
         render(Primer::Beta::State.new(title: title, scheme: scheme, size: size, tag: tag)) { "State" }
       end
@@ -32,16 +33,19 @@ module Primer
       end
 
       # @label Open
+      # @snapshot
       def states_open
         render(Primer::Beta::State.new(title: "Open", scheme: :open)) { "Open state" }
       end
 
       # @label Closed
+      # @snapshot
       def states_closed
         render(Primer::Beta::State.new(title: "Closed", scheme: :closed)) { "Closed state" }
       end
 
       # @label Merged
+      # @snapshot
       def states_merged
         render(Primer::Beta::State.new(title: "Merged", scheme: :merged)) { "Merged state" }
       end
@@ -51,11 +55,13 @@ module Primer
       # @!group Sizes
       #
       # @label Default
+      # @snapshot
       def sizes_default
         render(Primer::Beta::State.new(title: "Default")) { "Default size" }
       end
 
       # @label Small
+      # @snapshot
       def sizes_small
         render(Primer::Beta::State.new(title: "Default", size: :small)) { "Small size" }
       end

data/previews/primer/beta/subhead_preview.rb

@@ -27,6 +27,7 @@ module Primer
       # @param hide_border [Boolean]
       # @param heading_danger [Boolean]
       # @param heading_tag [Symbol] select [div, h1, h2, h3, h4, h5, h6]
+      # @snapshot
       def default(spacious: false, hide_border: false, heading_tag: :div, heading_danger: false)
         render(Primer::Beta::Subhead.new(spacious: spacious, hide_border: hide_border)) do |component|
           component.with_heading(tag: heading_tag, danger: heading_danger) do
@@ -39,6 +40,7 @@ module Primer
       end
 
       # @label Danger
+      # @snapshot
       def danger
         render(Primer::Beta::Subhead.new) do |component|
           component.with_heading(danger: true) do
@@ -51,6 +53,7 @@ module Primer
       end
 
       # @label Actions
+      # @snapshot
       def actions
         render_with_template(locals: {})
       end
@@ -70,6 +73,7 @@ module Primer
       end
 
       # @label Spacious
+      # @snapshot
       def spacing_spacious
         render(Primer::Beta::Subhead.new(spacious: true)) do |component|
           component.with_heading do

data/previews/primer/beta/text_preview.rb

@@ -16,6 +16,7 @@ module Primer
       #
       # @param tag [Symbol] select [div, p, span]
       # @param content [String] text
+      # @snapshot
       def default(tag: :span, content: "Text")
         render(Primer::Beta::Text.new(tag: tag)) { content }
       end

data/previews/primer/beta/timeline_item_preview.rb

@@ -18,6 +18,7 @@ module Primer
       # @label Default
       #
       # @param condensed [Boolean]
+      # @snapshot
       def default(condensed: false)
         render(Primer::Beta::TimelineItem.new(condensed: condensed)) do |component|
           component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "octocat")

data/previews/primer/beta/truncate_preview.rb

@@ -42,6 +42,7 @@ module Primer
       end
 
       # @label Max widths
+      # @snapshot
       def max_widths
         render(Primer::Beta::Truncate.new) do |component|
           component.with_item(max_width: 300) { "branch-name-that-is-really-long-branch-name-that-is-really-long-branch-name-that-is-really-long" }

data/previews/primer/box_preview.rb

@@ -16,11 +16,13 @@ module Primer
     end
 
     # @label Border
+    # @snapshot
     def border(content: "Box with border")
       render(Primer::Box.new(border: true, p: 3)) { content }
     end
 
     # @label Border Bottom
+    # @snapshot
     def border_bottom(content: "Box with bottom border")
       render(Primer::Box.new(border: :bottom, p: 3)) { content }
     end