primer_view_components 0.0.112 → 0.0.113

data/previews/primer/beta/relative_time_preview.rb

@@ -0,0 +1,271 @@
+# frozen_string_literal: true
+
+# Setup Playground to use all available component props
+# Setup Features to use individual component props and combinations
+
+module Primer
+  module Beta
+    # @label RelativeTime
+    class RelativeTimePreview < ViewComponent::Preview
+      # @label Playground
+      # @param datetime datetime-local
+      # @param tense [Symbol] select [~, auto, past, future]
+      # @param prefix [String] text
+      # @param second [Symbol] select [~, numeric, two_digit]
+      # @param minute [Symbol] select [~, numeric, two_digit]
+      # @param hour [Symbol] select [~, numeric, two_digit]
+      # @param weekday [Symbol] select [~, long, short, narrow]
+      # @param day [Symbol] select [~, numeric, two_digit]
+      # @param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
+      # @param year [Symbol] select [~, numeric, two_digit]
+      # @param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
+      # @param precision [Symbol] select [~, second, minute, hour, day, month, year]
+      # @param format [Symbol] select [~, auto, micro, elapsed]
+      # @param lang [String] text
+      # @param title [String] text
+      def playground(
+        tense: nil,
+        prefix: nil,
+        second: nil,
+        minute: nil,
+        hour: nil,
+        weekday: nil,
+        day: nil,
+        month: nil,
+        year: nil,
+        time_zone_name: nil,
+        threshold: nil,
+        precision: nil,
+        format: nil,
+        datetime: Time.utc(2020, 1, 1, 0, 0, 0),
+        lang: nil,
+        title: nil
+      )
+        render(Primer::Beta::RelativeTime.new(
+                 tense: tense,
+                 prefix: prefix,
+                 second: second,
+                 minute: minute,
+                 hour: hour,
+                 weekday: weekday,
+                 day: day,
+                 month: month,
+                 year: year,
+                 time_zone_name: time_zone_name,
+                 threshold: threshold,
+                 precision: precision,
+                 format: format,
+                 datetime: datetime,
+                 lang: lang,
+                 title: title
+               ))
+      end
+
+      # @label Default
+      # @param datetime datetime-local
+      # @param tense [Symbol] select [~, auto, past, future]
+      # @param prefix [String] text
+      # @param second [Symbol] select [~, numeric, two_digit]
+      # @param minute [Symbol] select [~, numeric, two_digit]
+      # @param hour [Symbol] select [~, numeric, two_digit]
+      # @param weekday [Symbol] select [~, long, short, narrow]
+      # @param day [Symbol] select [~, numeric, two_digit]
+      # @param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
+      # @param year [Symbol] select [~, numeric, two_digit]
+      # @param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
+      # @param precision [Symbol] select [~, second, minute, hour, day, month, year]
+      # @param format [Symbol] select [~, auto, micro, elapsed]
+      # @param lang [String] text
+      # @param title [String] text
+      def default(
+        tense: nil,
+        prefix: nil,
+        second: nil,
+        minute: nil,
+        hour: nil,
+        weekday: nil,
+        day: nil,
+        month: nil,
+        year: nil,
+        time_zone_name: nil,
+        threshold: nil,
+        precision: nil,
+        format: nil,
+        datetime: Time.now.utc,
+        lang: nil,
+        title: nil
+      )
+        render(Primer::Beta::RelativeTime.new(
+                 tense: tense,
+                 prefix: prefix,
+                 second: second,
+                 minute: minute,
+                 hour: hour,
+                 weekday: weekday,
+                 day: day,
+                 month: month,
+                 year: year,
+                 time_zone_name: time_zone_name,
+                 threshold: threshold,
+                 precision: precision,
+                 format: format,
+                 datetime: datetime,
+                 lang: lang,
+                 title: title
+               ))
+      end
+
+      # @label Micro Format
+      # @param datetime datetime-local
+      # @param tense [Symbol] select [~, auto, past, future]
+      # @param prefix [String] text
+      # @param second [Symbol] select [~, numeric, two_digit]
+      # @param minute [Symbol] select [~, numeric, two_digit]
+      # @param hour [Symbol] select [~, numeric, two_digit]
+      # @param weekday [Symbol] select [~, long, short, narrow]
+      # @param day [Symbol] select [~, numeric, two_digit]
+      # @param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
+      # @param year [Symbol] select [~, numeric, two_digit]
+      # @param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
+      # @param precision [Symbol] select [~, second, minute, hour, day, month, year]
+      # @param lang [String] text
+      # @param title [String] text
+      def micro_format(
+        tense: nil,
+        prefix: nil,
+        second: nil,
+        minute: nil,
+        hour: nil,
+        weekday: nil,
+        day: nil,
+        month: nil,
+        year: nil,
+        time_zone_name: nil,
+        threshold: nil,
+        precision: nil,
+        datetime: Time.now.iso8601,
+        lang: nil,
+        title: nil
+      )
+        render(Primer::Beta::RelativeTime.new(
+                 tense: tense,
+                 prefix: prefix,
+                 second: second,
+                 minute: minute,
+                 hour: hour,
+                 weekday: weekday,
+                 day: day,
+                 month: month,
+                 year: year,
+                 time_zone_name: time_zone_name,
+                 threshold: threshold,
+                 precision: precision,
+                 format: :micro,
+                 datetime: datetime,
+                 lang: lang,
+                 title: title
+               ))
+      end
+
+      # @label Recent Time
+      # @param datetime datetime-local
+      # @param tense [Symbol] select [~, auto, past, future]
+      # @param prefix [String] text
+      # @param second [Symbol] select [~, numeric, two_digit]
+      # @param minute [Symbol] select [~, numeric, two_digit]
+      # @param hour [Symbol] select [~, numeric, two_digit]
+      # @param weekday [Symbol] select [~, long, short, narrow]
+      # @param day [Symbol] select [~, numeric, two_digit]
+      # @param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
+      # @param year [Symbol] select [~, numeric, two_digit]
+      # @param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
+      # @param precision [Symbol] select [~, second, minute, hour, day, month, year]
+      # @param format [Symbol] select [~, auto, micro, elapsed]
+      # @param lang [String] text
+      # @param title [String] text
+      def recent_time(
+        tense: nil,
+        prefix: nil,
+        second: nil,
+        minute: nil,
+        hour: nil,
+        weekday: nil,
+        day: nil,
+        month: nil,
+        year: nil,
+        time_zone_name: nil,
+        threshold: nil,
+        precision: nil,
+        format: nil,
+        datetime: Time.now.iso8601,
+        lang: nil,
+        title: nil
+      )
+        render(Primer::Beta::RelativeTime.new(
+                 tense: tense,
+                 prefix: prefix,
+                 second: second,
+                 minute: minute,
+                 hour: hour,
+                 weekday: weekday,
+                 day: day,
+                 month: month,
+                 year: year,
+                 time_zone_name: time_zone_name,
+                 threshold: threshold,
+                 precision: precision,
+                 format: format,
+                 datetime: datetime,
+                 lang: lang,
+                 title: title
+               ))
+      end
+
+      # @label Count Down Timer
+      # @param datetime datetime-local
+      # @param tense [Symbol] select [~, auto, past, future]
+      # @param prefix [String] text
+      # @param second [Symbol] select [~, numeric, two_digit]
+      # @param minute [Symbol] select [~, numeric, two_digit]
+      # @param hour [Symbol] select [~, numeric, two_digit]
+      # @param weekday [Symbol] select [~, long, short, narrow]
+      # @param year [Symbol] select [~, numeric, two_digit]
+      # @param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
+      # @param precision [Symbol] select [~, second, minute, hour, day, month, year]
+      # @param lang [String] text
+      # @param title [String] text
+      def count_down_timer(
+        tense: nil,
+        prefix: nil,
+        second: nil,
+        minute: nil,
+        hour: nil,
+        weekday: nil,
+        year: nil,
+        time_zone_name: nil,
+        threshold: nil,
+        precision: nil,
+        datetime: Time.utc(2038, 1, 19, 0o3, 14, 8),
+        lang: nil,
+        title: nil
+      )
+        render(Primer::Beta::RelativeTime.new(
+                 tense: tense,
+                 prefix: prefix,
+                 second: second,
+                 minute: minute,
+                 hour: hour,
+                 weekday: weekday,
+                 year: year,
+                 time_zone_name: time_zone_name,
+                 threshold: threshold,
+                 precision: precision,
+                 format: :elapsed,
+                 datetime: datetime,
+                 lang: lang,
+                 title: title
+               ))
+      end
+    end
+  end
+end

data/previews/primer/forms/forms_preview.rb

@@ -2,6 +2,7 @@
 
 module Primer
   module Forms
+    # :nodoc:
     class FormsPreview < ViewComponent::Preview
       def single_text_field_form; end
 

data/static/arguments.json

@@ -1387,6 +1387,38 @@
       }
     ]
   },
+  {
+    "component": "ClipboardCopy",
+    "status": "beta",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/clipboard_copy.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy/default/",
+    "parameters": [
+      {
+        "name": "aria-label",
+        "type": "String",
+        "default": "N/A",
+        "description": "String that will be read to screenreaders when the component is focused"
+      },
+      {
+        "name": "value",
+        "type": "String",
+        "default": "`nil`",
+        "description": "Text to copy into the users clipboard when they click the component."
+      },
+      {
+        "name": "for",
+        "type": "String",
+        "default": "N/A",
+        "description": "Element id from where to get the copied value."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "CloseButton",
     "status": "beta",
@@ -1743,6 +1775,116 @@
       }
     ]
   },
+  {
+    "component": "RelativeTime",
+    "status": "beta",
+    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/relative_time.rb",
+    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time/default/",
+    "parameters": [
+      {
+        "name": "datetime",
+        "type": "Time",
+        "default": "N/A",
+        "description": "The time to be formatted."
+      },
+      {
+        "name": "tense",
+        "type": "Symbol",
+        "default": "`:auto`",
+        "description": "Which tense to use. One of `:auto`, `:future`, or `:past`."
+      },
+      {
+        "name": "prefix",
+        "type": "sring",
+        "default": "`nil`",
+        "description": "What to prefix the relative ime display with."
+      },
+      {
+        "name": "second",
+        "type": "Symbol",
+        "default": "`SECOND_DEFAULT`",
+        "description": "What format seconds should take. One of `nil`, `:numeric`, or `:two_digit`."
+      },
+      {
+        "name": "minute",
+        "type": "Symbol",
+        "default": "`MINUTE_DEFAULT`",
+        "description": "What format minues should take. One of `nil`, `:numeric`, or `:two_digit`."
+      },
+      {
+        "name": "hour",
+        "type": "Symbol",
+        "default": "`HOUR_DEFAULT`",
+        "description": "What format hours should take. One of `nil`, `:numeric`, or `:two_digit`."
+      },
+      {
+        "name": "weekday",
+        "type": "Symbol",
+        "default": "`WEEKDAY_DEFAULT`",
+        "description": "What format weekdays should take. One of `nil`, `:long`, `:narrow`, or `:short`."
+      },
+      {
+        "name": "day",
+        "type": "Symbol",
+        "default": "`DAY_DEFAULT`",
+        "description": "What format days should take. One of `nil`, `:numeric`, or `:two_digit`."
+      },
+      {
+        "name": "month",
+        "type": "Symbol",
+        "default": "`MONTH_DEFAULT`",
+        "description": "What format months should take. One of `nil`, `:long`, `:narrow`, `:numeric`, `:short`, or `:two_digit`."
+      },
+      {
+        "name": "year",
+        "type": "Symbol",
+        "default": "`YEAR_DEFAULT`",
+        "description": "What format years should take. One of `nil`, `:numeric`, or `:two_digit`."
+      },
+      {
+        "name": "time_zone_name",
+        "type": "Symbol",
+        "default": "`TIMEZONENAME_DEFAULT`",
+        "description": "What format the time zone should take. One of `nil`, `:long`, `:long_generic`, `:long_offset`, `:short`, `:short_generic`, or `:short_offset`."
+      },
+      {
+        "name": "threshold",
+        "type": "string",
+        "default": "`nil`",
+        "description": "The threshold at which relative time displays become absolute."
+      },
+      {
+        "name": "precision",
+        "type": "Symbol",
+        "default": "`PRECISION_DEFAULT`",
+        "description": "The precision elapsed time should display. One of `nil`, `:day`, `:hour`, `:minute`, `:month`, `:second`, or `:year`."
+      },
+      {
+        "name": "format",
+        "type": "Symbol",
+        "default": "`nil`",
+        "description": "The format the display should take. One of `:auto`, `:elapsed`, or `:micro`."
+      },
+      {
+        "name": "lang",
+        "type": "string",
+        "default": "`nil`",
+        "description": "The language to use."
+      },
+      {
+        "name": "title",
+        "type": "string",
+        "default": "`nil`",
+        "description": "Provide a custom title to the element."
+      },
+      {
+        "name": "system_arguments",
+        "type": "Hash",
+        "default": "N/A",
+        "description": "[System arguments](/system-arguments)"
+      }
+    ]
+  },
   {
     "component": "Text",
     "status": "beta",
@@ -1793,7 +1935,7 @@
   },
   {
     "component": "Button",
-    "status": "beta",
+    "status": "deprecated",
     "source": "https://github.com/primer/view_components/tree/main/app/components/primer/button_component.rb",
     "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button/default/",
     "parameters": [
@@ -1853,38 +1995,6 @@
       }
     ]
   },
-  {
-    "component": "ClipboardCopy",
-    "status": "beta",
-    "source": "https://github.com/primer/view_components/tree/main/app/components/primer/clipboard_copy.rb",
-    "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/clipboard_copy/default/",
-    "parameters": [
-      {
-        "name": "aria-label",
-        "type": "String",
-        "default": "N/A",
-        "description": "String that will be read to screenreaders when the component is focused"
-      },
-      {
-        "name": "value",
-        "type": "String",
-        "default": "`nil`",
-        "description": "Text to copy into the users clipboard when they click the component."
-      },
-      {
-        "name": "for",
-        "type": "String",
-        "default": "N/A",
-        "description": "Element id from where to get the copied value."
-      },
-      {
-        "name": "system_arguments",
-        "type": "Hash",
-        "default": "N/A",
-        "description": "[System arguments](/system-arguments)"
-      }
-    ]
-  },
   {
     "component": "DropdownMenu",
     "status": "deprecated",

data/static/audited_at.json

@@ -7,10 +7,10 @@
   "Primer::Alpha::AutoComplete::Item": "",
   "Primer::Alpha::Banner": "",
   "Primer::Alpha::ButtonMarketing": "",
-  "Primer::Alpha::Dialog": "",
-  "Primer::Alpha::Dialog::Body": "",
-  "Primer::Alpha::Dialog::Footer": "",
-  "Primer::Alpha::Dialog::Header": "",
+  "Primer::Alpha::Dialog": "2022-10-10",
+  "Primer::Alpha::Dialog::Body": "2022-10-10",
+  "Primer::Alpha::Dialog::Footer": "2022-10-10",
+  "Primer::Alpha::Dialog::Header": "2022-10-10",
   "Primer::Alpha::Dropdown": "",
   "Primer::Alpha::Dropdown::Menu": "",
   "Primer::Alpha::Dropdown::Menu::Item": "",
@@ -45,6 +45,7 @@
   "Primer::Beta::Breadcrumbs::Item": "",
   "Primer::Beta::Button": "",
   "Primer::Beta::ButtonGroup": "",
+  "Primer::Beta::ClipboardCopy": "",
   "Primer::Beta::CloseButton": "",
   "Primer::Beta::Counter": "",
   "Primer::Beta::Details": "",
@@ -55,6 +56,7 @@
   "Primer::Beta::Link": "",
   "Primer::Beta::Popover": "",
   "Primer::Beta::ProgressBar": "",
+  "Primer::Beta::RelativeTime": "",
   "Primer::Beta::Text": "",
   "Primer::Beta::Truncate": "",
   "Primer::Beta::Truncate::TruncateText": "",

data/static/constants.json

@@ -558,6 +558,8 @@
   },
   "Primer::Beta::ButtonGroup": {
   },
+  "Primer::Beta::ClipboardCopy": {
+  },
   "Primer::Beta::CloseButton": {
     "DEFAULT_TYPE": "button",
     "TYPE_OPTIONS": [
@@ -738,6 +740,128 @@
       "large"
     ]
   },
+  "Primer::Beta::RelativeTime": {
+    "DAY_DEFAULT": null,
+    "DAY_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit"
+    },
+    "DAY_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit"
+    ],
+    "FORMAT_DEFAULT": "auto",
+    "FORMAT_OPTIONS": [
+      "auto",
+      "micro",
+      "elapsed"
+    ],
+    "HOUR_DEFAULT": null,
+    "HOUR_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit"
+    },
+    "HOUR_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit"
+    ],
+    "MINUTE_DEFAULT": null,
+    "MINUTE_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit"
+    },
+    "MINUTE_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit"
+    ],
+    "MONTH_DEFAULT": null,
+    "MONTH_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit",
+      "short": "short",
+      "long": "long",
+      "narrow": "narrow"
+    },
+    "MONTH_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit",
+      "short",
+      "long",
+      "narrow"
+    ],
+    "PRECISION_DEFAULT": null,
+    "PRECISION_OPTIONS": [
+      null,
+      "second",
+      "minute",
+      "hour",
+      "day",
+      "month",
+      "year"
+    ],
+    "SECOND_DEFAULT": null,
+    "SECOND_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit"
+    },
+    "SECOND_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit"
+    ],
+    "TENSE_DEFAULT": "auto",
+    "TENSE_OPTIONS": [
+      "auto",
+      "past",
+      "future"
+    ],
+    "TIMEZONENAME_DEFAULT": null,
+    "TIMEZONENAME_OPTIONS": [
+      null,
+      "long",
+      "short",
+      "short_offset",
+      "long_offset",
+      "short_generic",
+      "long_generic"
+    ],
+    "TIMEZONE_MAPPINGS": {
+      "": null,
+      "long": "long",
+      "short": "short",
+      "short_offset": "shortOffset",
+      "long_offset": "longOffset",
+      "short_generic": "shortGeneric",
+      "long_generic": "longGeneric"
+    },
+    "WEEKDAY_DEFAULT": null,
+    "WEEKDAY_OPTIONS": [
+      null,
+      "long",
+      "short",
+      "narrow"
+    ],
+    "YEAR_DEFAULT": null,
+    "YEAR_MAPPINGS": {
+      "": null,
+      "numeric": "numeric",
+      "two_digit": "2-digit"
+    },
+    "YEAR_OPTIONS": [
+      null,
+      "numeric",
+      "two_digit"
+    ]
+  },
   "Primer::Beta::Text": {
     "DEFAULT_TAG": "span"
   },

data/static/statuses.json

@@ -45,6 +45,7 @@
   "Primer::Beta::Breadcrumbs::Item": "alpha",
   "Primer::Beta::Button": "beta",
   "Primer::Beta::ButtonGroup": "beta",
+  "Primer::Beta::ClipboardCopy": "beta",
   "Primer::Beta::CloseButton": "beta",
   "Primer::Beta::Counter": "beta",
   "Primer::Beta::Details": "beta",
@@ -55,14 +56,15 @@
   "Primer::Beta::Link": "beta",
   "Primer::Beta::Popover": "beta",
   "Primer::Beta::ProgressBar": "beta",
+  "Primer::Beta::RelativeTime": "beta",
   "Primer::Beta::Text": "beta",
   "Primer::Beta::Truncate": "beta",
   "Primer::Beta::Truncate::TruncateText": "alpha",
   "Primer::BlankslateComponent": "deprecated",
   "Primer::Box": "stable",
   "Primer::BoxComponent": "deprecated",
-  "Primer::ButtonComponent": "beta",
-  "Primer::ClipboardCopy": "beta",
+  "Primer::ButtonComponent": "deprecated",
+  "Primer::ClipboardCopy": "deprecated",
   "Primer::ConditionalWrapper": "alpha",
   "Primer::Content": "stable",
   "Primer::Dropdown": "deprecated",