primer_view_components 0.0.109 → 0.0.110

data/previews/primer/alpha/segmented_control_preview.rb

@@ -23,53 +23,139 @@ module Primer
         end
       end
 
-      # @param full_width [Boolean] toggle
-      # @param size select [small, medium, large]
-      def default(full_width: false, size: :medium)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: full_width, size: size)) do |c|
+      # @label Default
+      def default
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view")) do |c|
           c.with_item(label: "Preview", selected: true)
           c.with_item(label: "Raw")
           c.with_item(label: "Blame")
         end
       end
 
-      # @param hide_labels [Boolean] toggle
-      # @param size select [small, medium, large]
-      def full_width(hide_labels: false, size: :medium)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, hide_labels: hide_labels, size: size)) do |c|
-          c.with_item(label: "Preview", icon: (hide_labels ? :zap : nil), selected: true)
-          c.with_item(label: "Raw", icon: (hide_labels ? :zap : nil))
-          c.with_item(label: "Blame", icon: (hide_labels ? :zap : nil))
+      # @!group Full width
+      # @label Size small
+      def full_width_small(hide_labels: false, size: :small)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :small)) do |c|
+          c.with_item(label: "Preview", selected: true)
+          c.with_item(label: "Raw")
+          c.with_item(label: "Blame")
         end
       end
 
-      # @param full_width [Boolean] toggle
-      # @param size select [small, medium, large]
-      def icons_and_text(full_width: false, size: :medium)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: full_width, size: size)) do |c|
+      # @label Size medium
+      def full_width_medium(hide_labels: false, size: :medium)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :medium)) do |c|
+          c.with_item(label: "Preview", selected: true)
+          c.with_item(label: "Raw")
+          c.with_item(label: "Blame")
+        end
+      end
+
+      # @label Size large
+      def full_width_large(hide_labels: false, size: :large)
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: true, size: :large)) do |c|
+          c.with_item(label: "Preview", selected: true)
+          c.with_item(label: "Raw")
+          c.with_item(label: "Blame")
+        end
+      end
+      # @!endgroup
+
+      # @!group Icons and text
+      # @label Size small
+      def icons_and_text_small
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", size: :small)) do |c|
           c.with_item(label: "Preview", icon: :eye, selected: true)
           c.with_item(label: "Raw", icon: :"file-code")
           c.with_item(label: "Blame", icon: :people)
         end
       end
 
-      # @param full_width [Boolean] toggle
-      # @param size select [small, medium, large]
-      def icons_only(full_width: false, size: :medium)
-        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", full_width: full_width, hide_labels: true, size: size)) do |c|
+      # @label Size medium
+      def icons_and_text_medium
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", size: :medium)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Size large
+      def icons_and_text_large
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", size: :large)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+      # @!endgroup
+
+      # @!group Icons only
+      # @label Size small
+      def icon_only_small
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, size: :small)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Size medium
+      def icon_only_medium
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, size: :medium)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Size large
+      def icon_only_large
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, size: :large)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Full width, size small
+      def icon_only_full_width_small
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, full_width: true, size: :small)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Full width, size medium
+      def icon_only_full_width_medium
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, full_width: true, size: :medium)) do |c|
+          c.with_item(label: "Preview", icon: :eye, selected: true)
+          c.with_item(label: "Raw", icon: :"file-code")
+          c.with_item(label: "Blame", icon: :people)
+        end
+      end
+
+      # @label Full width, size large
+      def icon_only_full_width_large
+        render(Primer::Alpha::SegmentedControl.new("aria-label": "File view", hide_labels: true, full_width: true, size: :large)) do |c|
           c.with_item(label: "Preview", icon: :eye, selected: true)
           c.with_item(label: "Raw", icon: :"file-code")
           c.with_item(label: "Blame", icon: :people)
         end
       end
+      # @!endgroup
 
-      def with_links_as_tags
+      # NOTE: this preview uses a group to force it's display below the other groups
+      # @!group With link as tag
+      def with_link_as_tag
         render(Primer::Alpha::SegmentedControl.new) do |c|
           c.with_item(tag: :a, href: "#", label: "Preview", icon: :eye, selected: true)
           c.with_item(tag: :a, href: "#", label: "Raw", icon: :"file-code")
           c.with_item(tag: :a, href: "#", label: "Blame", icon: :people)
         end
       end
+      # @!endgroup
     end
   end
 end

data/previews/primer/beta/counter_preview.rb

@@ -16,20 +16,67 @@ module Primer
       end
 
       # @label Default Options
-      #
-      # @param count number
-      # @param limit number
-      # @param hide_if_zero toggle
-      # @param round toggle
-      # @param scheme [Symbol] select [[Default, default], [Primary, primary], [Secondary, secondary]]]
-      def default(count: 1_000, limit: nil, round: false, hide_if_zero: false, scheme: :default)
-        render(Primer::Beta::Counter.new(count: count, round: round, limit: limit, hide_if_zero: hide_if_zero, scheme: scheme))
+      def default
+        render(Primer::Beta::Counter.new(count: 1_000))
       end
 
       # @label With Text
       def with_text
         render(Primer::Beta::Counter.new(text: "∞"))
       end
+
+      # @!group Color Schemes
+      #
+      # @label Default
+      def color_scheme_default
+        render(Primer::Beta::Counter.new(count: 1_000))
+      end
+
+      # @label Primary
+      def color_scheme_primary
+        render(Primer::Beta::Counter.new(count: 1_000, scheme: :primary))
+      end
+
+      # @label Secondary
+      def color_scheme_secondary
+        render(Primer::Beta::Counter.new(count: 1_000, scheme: :secondary))
+      end
+      #
+      # @!endgroup
+
+      # @!group Rounded Number
+      #
+      # @label Default (No Rounding)
+      def rounding_default
+        render(Primer::Beta::Counter.new(count: 1_234))
+      end
+
+      # @label Rounded Above 1,000
+      def rounding_above_1000
+        render(Primer::Beta::Counter.new(count: 1_234, round: true))
+      end
+
+      # @label Rounded Below 1,000
+      def rounding_below_1000
+        render(Primer::Beta::Counter.new(count: 999, round: true))
+      end
+
+      # @label Rounded Large Numbers w/ Default Limit
+      def rounding_large_number
+        render(Primer::Beta::Counter.new(count: 4_567_890, round: true))
+      end
+
+      # @label Rounded Large Numbers, Less Than Custom Limit
+      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
+      def rounding_large_number_greater_than_custom_limit
+        render(Primer::Beta::Counter.new(count: 4_567_890, limit: 1_000_000, round: true))
+      end
+      #
+      # @!endgroup
     end
   end
 end

data/previews/primer/beta/progress_bar_preview.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Primer
+  module Beta
+    # @label ProgressBar
+    class ProgressBarPreview < ViewComponent::Preview
+      # @label Playground
+      #
+      # @param size [Symbol] select [default, small, large]
+      def playground(size: :default)
+        render(Primer::Beta::ProgressBar.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
+
+      # @label Default
+      #
+      # @param size [Symbol] select [default, small, large]
+      def default(size: :default)
+        render(Primer::Beta::ProgressBar.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
+
+      # @!group Sizes
+      #
+      # @label Size small
+      def size_small
+        render(Primer::Beta::ProgressBar.new(size: :small)) 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
+
+      # @label Size default
+      def size_default
+        render(Primer::Beta::ProgressBar.new(size: :default)) 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
+
+      # @label Size large
+      def size_large
+        render(Primer::Beta::ProgressBar.new(size: :large)) 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
+      # @!endgroup
+    end
+  end
+end

data/static/arguments.json

@@ -205,6 +205,62 @@
       }
     ]
   },
+  {
+    "component": "Banner",
+    "status": "alpha",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/banner.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/banner/default/",
+    "parameters": [
+      {
+        "name": "full",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether the component should take up the full width of the screen."
+      },
+      {
+        "name": "full_when_narrow",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
+      },
+      {
+        "name": "dismissible",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether the component can be dismissed with an \"x\" button."
+      },
+      {
+        "name": "description",
+        "type": "String",
+        "default": "`nil`",
+        "description": "Description text rendered underneath the message."
+      },
+      {
+        "name": "icon",
+        "type": "Symbol",
+        "default": "`nil`",
+        "description": "The name of an [Octicon](https://primer.style/octicons/) icon to use. If no icon is provided, a default one will be chosen based on the scheme."
+      },
+      {
+        "name": "scheme",
+        "type": "Symbol",
+        "default": "`:default`",
+        "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
+      },
+      {
+        "name": "reappear",
+        "type": "Boolean",
+        "default": "`false`",
+        "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "ButtonMarketing",
     "status": "alpha",
@@ -1117,62 +1173,6 @@
       }
     ]
   },
-  {
-    "component": "Banner",
-    "status": "beta",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/banner.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/banner/default/",
-    "parameters": [
-      {
-        "name": "full",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether the component should take up the full width of the screen."
-      },
-      {
-        "name": "full_when_narrow",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether the component should take up the full width of the screen when rendered inside smaller viewports."
-      },
-      {
-        "name": "dismissible",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether the component can be dismissed with an \"x\" button."
-      },
-      {
-        "name": "description",
-        "type": "String",
-        "default": "`nil`",
-        "description": "Description text rendered underneath the message."
-      },
-      {
-        "name": "icon",
-        "type": "Symbol",
-        "default": "`nil`",
-        "description": "The name of an [Octicon](https://primer.style/octicons/) icon to use. If no icon is provided, a default one will be chosen based on the scheme."
-      },
-      {
-        "name": "scheme",
-        "type": "Symbol",
-        "default": "`:default`",
-        "description": "One of `:danger`, `:default`, `:success`, or `:warning`."
-      },
-      {
-        "name": "reappear",
-        "type": "Boolean",
-        "default": "`false`",
-        "description": "Whether or not the flash banner should reappear after being dismissed. Only for use in test and preview environments."
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
   {
     "component": "BaseButton",
     "status": "beta",
@@ -1683,6 +1683,26 @@
       }
     ]
   },
+  {
+    "component": "ProgressBar",
+    "status": "beta",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/progress_bar.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/progress_bar/default/",
+    "parameters": [
+      {
+        "name": "size",
+        "type": "Symbol",
+        "default": "`:default`",
+        "description": "One of `:default`, `:large`, or `:small`. Increases height."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "Text",
     "status": "beta",
@@ -2221,26 +2241,6 @@
       }
     ]
   },
-  {
-    "component": "ProgressBar",
-    "status": "beta",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/progress_bar_component.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/progress_bar/default/",
-    "parameters": [
-      {
-        "name": "size",
-        "type": "Symbol",
-        "default": "`:default`",
-        "description": "One of `:default`, `:large`, or `:small`. Increases height."
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
   {
     "component": "Spinner",
     "status": "beta",

data/static/audited_at.json

@@ -5,6 +5,7 @@
   "Primer::Alpha::ActionList::Item": "",
   "Primer::Alpha::AutoComplete": "",
   "Primer::Alpha::AutoComplete::Item": "",
+  "Primer::Alpha::Banner": "",
   "Primer::Alpha::ButtonMarketing": "",
   "Primer::Alpha::Dialog": "",
   "Primer::Alpha::Dialog::Body": "",
@@ -33,7 +34,6 @@
   "Primer::Beta::AutoComplete::Item": "",
   "Primer::Beta::Avatar": "",
   "Primer::Beta::AvatarStack": "",
-  "Primer::Beta::Banner": "",
   "Primer::Beta::BaseButton": "",
   "Primer::Beta::Blankslate": "",
   "Primer::Beta::BorderBox": "",
@@ -50,6 +50,7 @@
   "Primer::Beta::IconButton": "",
   "Primer::Beta::Label": "",
   "Primer::Beta::Link": "",
+  "Primer::Beta::ProgressBar": "",
   "Primer::Beta::Text": "",
   "Primer::Beta::Truncate": "",
   "Primer::Beta::Truncate::TruncateText": "",

data/static/constants.json

@@ -72,6 +72,27 @@
   },
   "Primer::Alpha::AutoComplete::Item": {
   },
+  "Primer::Alpha::Banner": {
+    "DEFAULT_ICONS": {
+      "default": "bell",
+      "warning": "alert",
+      "danger": "stop",
+      "success": "check-circle"
+    },
+    "DEFAULT_SCHEME": "default",
+    "LEGACY_SCHEME_MAPPINGS": {
+      "default": "",
+      "warning": "flash-warn",
+      "danger": "flash-error",
+      "success": "flash-success"
+    },
+    "SCHEME_MAPPINGS": {
+      "default": "",
+      "warning": "Banner--warning",
+      "danger": "Banner--error",
+      "success": "Banner--success"
+    }
+  },
   "Primer::Alpha::ButtonMarketing": {
     "DEFAULT_SCHEME": "default",
     "DEFAULT_TAG": "button",
@@ -396,27 +417,6 @@
       "span"
     ]
   },
-  "Primer::Beta::Banner": {
-    "DEFAULT_ICONS": {
-      "default": "bell",
-      "warning": "alert",
-      "danger": "stop",
-      "success": "check-circle"
-    },
-    "DEFAULT_SCHEME": "default",
-    "LEGACY_SCHEME_MAPPINGS": {
-      "default": "",
-      "warning": "flash-warn",
-      "danger": "flash-error",
-      "success": "flash-success"
-    },
-    "SCHEME_MAPPINGS": {
-      "default": "",
-      "warning": "Banner--warning",
-      "danger": "Banner--error",
-      "success": "Banner--success"
-    }
-  },
   "Primer::Beta::BaseButton": {
     "DEFAULT_TAG": "button",
     "DEFAULT_TYPE": "button",
@@ -670,6 +670,19 @@
       "span"
     ]
   },
+  "Primer::Beta::ProgressBar": {
+    "SIZE_DEFAULT": "default",
+    "SIZE_MAPPINGS": {
+      "default": "",
+      "small": "Progress--small",
+      "large": "Progress--large"
+    },
+    "SIZE_OPTIONS": [
+      "default",
+      "small",
+      "large"
+    ]
+  },
   "Primer::Beta::Text": {
     "DEFAULT_TAG": "span"
   },
@@ -889,17 +902,6 @@
     "DEFAULT_HEADING_TAG": "h4"
   },
   "Primer::ProgressBarComponent": {
-    "SIZE_DEFAULT": "default",
-    "SIZE_MAPPINGS": {
-      "default": "",
-      "small": "Progress--small",
-      "large": "Progress--large"
-    },
-    "SIZE_OPTIONS": [
-      "default",
-      "small",
-      "large"
-    ]
   },
   "Primer::SpinnerComponent": {
     "DEFAULT_SIZE": "medium",

data/static/statuses.json

@@ -5,6 +5,7 @@
   "Primer::Alpha::ActionList::Item": "alpha",
   "Primer::Alpha::AutoComplete": "deprecated",
   "Primer::Alpha::AutoComplete::Item": "deprecated",
+  "Primer::Alpha::Banner": "alpha",
   "Primer::Alpha::ButtonMarketing": "alpha",
   "Primer::Alpha::Dialog": "alpha",
   "Primer::Alpha::Dialog::Body": "alpha",
@@ -33,7 +34,6 @@
   "Primer::Beta::AutoComplete::Item": "beta",
   "Primer::Beta::Avatar": "beta",
   "Primer::Beta::AvatarStack": "beta",
-  "Primer::Beta::Banner": "beta",
   "Primer::Beta::BaseButton": "beta",
   "Primer::Beta::Blankslate": "beta",
   "Primer::Beta::BorderBox": "beta",
@@ -50,6 +50,7 @@
   "Primer::Beta::IconButton": "beta",
   "Primer::Beta::Label": "beta",
   "Primer::Beta::Link": "beta",
+  "Primer::Beta::ProgressBar": "beta",
   "Primer::Beta::Text": "beta",
   "Primer::Beta::Truncate": "beta",
   "Primer::Beta::Truncate::TruncateText": "alpha",
@@ -78,7 +79,7 @@
   "Primer::OcticonComponent": "beta",
   "Primer::OcticonSymbolsComponent": "alpha",
   "Primer::PopoverComponent": "beta",
-  "Primer::ProgressBarComponent": "beta",
+  "Primer::ProgressBarComponent": "deprecated",
   "Primer::SpinnerComponent": "beta",
   "Primer::StateComponent": "beta",
   "Primer::SubheadComponent": "beta",