diff --git a/.changeset/mean-poets-poke.md b/.changeset/mean-poets-poke.md new file mode 100644 index 0000000000..92b8449cb0 --- /dev/null +++ b/.changeset/mean-poets-poke.md @@ -0,0 +1,5 @@ +--- +'@primer/view-components': patch +--- + +Deprecating Primer::TimeAgo in favor of Primer::RelativeTime, and adding a migration guide diff --git a/app/components/primer/time_ago_component.rb b/app/components/primer/time_ago_component.rb index a0614675a8..f13d66ff4f 100644 --- a/app/components/primer/time_ago_component.rb +++ b/app/components/primer/time_ago_component.rb @@ -3,7 +3,7 @@ module Primer # Use `TimeAgo` to display a time relative to how long ago it was. This component requires JavaScript. class TimeAgoComponent < Primer::Component - status :beta + status :deprecated # @example Default # <%= render(Primer::TimeAgoComponent.new(time: Time.at(628232400))) %> diff --git a/docs/content/guides/primer_time_ago.md b/docs/content/guides/primer_time_ago.md new file mode 100644 index 0000000000..9dec7616c1 --- /dev/null +++ b/docs/content/guides/primer_time_ago.md @@ -0,0 +1,50 @@ +--- +title: Moving Away From `Primer::TimeAgoComponent` +--- + +This guide will show you how to upgrade from the now deprecated +[`Primer::TimeAgoComponent`](https://primer.style/view-components/components/timeago) +to the latest [`Primer::Beta::RelativeTime`](https://primer.style/view-components/components/beta/relativetime) +component. + +## A Migration Example + +Use of the `TimeAgoComponent` component can be migrated with only a few minor changes. + +For example, if the `TimeAgoComponent` was set up in this way: + +```rb +<%= render(Primer::TimeAgoComponent.new(time: Time.at(628232400))) %> +``` + +It can be migrated by renaming `time` to `datetime`, and adding the `tense: +:past` setting. + +```rb +<%= render(Primer::Beta::RelativeTime.new(datetime: Time.at(628232400), tense: :past)) %> +``` + +## Arguments + +The majority of options available in `RelativeTime` are not relevant when +using it as a replacement for `TimeAgo`. There are a few changes that need to be +noted, however. + +| From `Primer::TimeAgoComponent` | To `Primer::Beta::RelativeTime` | Notes | +|---------------------------------|---------------------------------|-------| +| `time` | `datetime` | Renamed argument, but the semantics remain the same | +| `micro` | `format: :micro` | Instead of a boolean flag, set the `format` argument to the value of `:micro` | +| n/a | `tense: :past` | Required for displaying how long ago the set time was. This argument tells `RelativeTime` to behave like `TimeAgo` did. | + +The remaining arguments for `RelativeTime` can be found in the docu7mentation +for that component. + +Please see the following for complete descriptions and examples. + +* [Deprecated `Primer::TimeAgoComponent`](https://primer.style/view-components/components/timeago) +* [`Primer::Beta::RelativeTime` component](https://primer.style/view-components/components/beta/relativetime) +* [`Primer::Beta::RelativeTime` Lookbook examples](https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time_preview/default) + +

 

+ +[← Back to migration guides](https://primer.style/view-components/migration) diff --git a/docs/content/migration.md b/docs/content/migration.md index fd1a22cff7..704b5c43e8 100644 --- a/docs/content/migration.md +++ b/docs/content/migration.md @@ -30,3 +30,4 @@ components. | [`Primer::ButtonComponent`](https://primer.style/view-components/components/button) | [`Primer::Beta::Button`](https://primer.style/view-components/components/beta/button) | [Upgrade to Primer::Beta::Button](https://primer.style/view-components/guides/primer_button_component) | | [`Primer::DropdownMenuComponent`](https://primer.style/view-components/components/dropdownmenu) | [`Primer::Alpha::Dropdown`](https://primer.style/view-components/components/alpha/dropdown) | [Upgrade to Primer::Alpha::Dropdown](https://primer.style/view-components/guides/primer_dropdown_menu_component) | | [`Primer::LocalTime`](https://primer.style/view-components/components/localtime) | [`Primer::Beta::RelativeTime`](https://primer.style/view-components/components/beta/relativetime) | [Upgrade to Primer::Beta::RelativeTime](https://primer.style/view-components/guides/primer_local_time) | +| [`Primer::TimeAgoComponent`](https://primer.style/view-components/components/timeago) | [`Primer::Beta::RelativeTime`](https://primer.style/view-components/components/beta/relativetime) | [Upgrade to Primer::Beta::RelativeTime](https://primer.style/view-components/guides/primer_time_ago) | diff --git a/docs/src/@primer/gatsby-theme-doctocat/nav.yml b/docs/src/@primer/gatsby-theme-doctocat/nav.yml index 27aa7fdd7f..43ac97abe7 100644 --- a/docs/src/@primer/gatsby-theme-doctocat/nav.yml +++ b/docs/src/@primer/gatsby-theme-doctocat/nav.yml @@ -103,8 +103,6 @@ url: "/components/beta/text" - title: TextField url: "/components/alpha/textfield" - - title: TimeAgo - url: "/components/timeago" - title: TimelineItem url: "/components/timelineitem" - title: ToggleSwitch @@ -131,6 +129,8 @@ url: "/components/iconbutton" - title: LocalTime url: "/components/localtime" + - title: TimeAgo + url: "/components/timeago" - title: Tooltip url: "/components/tooltip" - title: Architecture decisions diff --git a/lib/primer/deprecations.yml b/lib/primer/deprecations.yml index 87fe69d603..59537eda72 100644 --- a/lib/primer/deprecations.yml +++ b/lib/primer/deprecations.yml @@ -80,6 +80,11 @@ deprecations: autocorrect: true replacement: "Primer::Beta::Popover" + - component: "Primer::TimeAgoComponent" + autocorrect: false + replacement: "Primer::Beta::RelativeTime" + guide: "https://primer.style/view-components/guides/primer_time_ago" + - component: "Primer::Tooltip" autocorrect: true replacement: "Primer::Alpha::Tooltip" diff --git a/lib/tasks/docs.rake b/lib/tasks/docs.rake index 7c5e30a8a0..911377b7dd 100644 --- a/lib/tasks/docs.rake +++ b/lib/tasks/docs.rake @@ -515,7 +515,7 @@ namespace :docs do def lookbook_url(component) path = component.name.underscore.gsub("_component", "") - "https://primer.style/view-components/lookbook/inspect/#{path}/default/" + "https://primer.style/view-components/lookbook/inspect/#{path}_preview/default/" end def preview_exists?(component) diff --git a/static/arguments.json b/static/arguments.json index 074cf35f1f..1c6281a069 100644 --- a/static/arguments.json +++ b/static/arguments.json @@ -3,7 +3,7 @@ "component": "ActionList", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list_preview/default/", "parameters": [ { "name": "role", @@ -41,7 +41,7 @@ "component": "ActionList::Divider", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/divider.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/divider_preview/default/", "parameters": [ { "name": "scheme", @@ -61,7 +61,7 @@ "component": "ActionList::Heading", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/heading.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/heading_preview/default/", "parameters": [ { "name": "list_id", @@ -105,7 +105,7 @@ "component": "ActionList::Item", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/action_list/item.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/action_list/item_preview/default/", "parameters": [ { "name": "list", @@ -209,7 +209,7 @@ "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/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/banner_preview/default/", "parameters": [ { "name": "full", @@ -265,7 +265,7 @@ "component": "ButtonMarketing", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/button_marketing.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/button_marketing_preview/default/", "parameters": [ { "name": "scheme", @@ -303,7 +303,7 @@ "component": "Dialog", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dialog.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dialog_preview/default/", "parameters": [ { "name": "id", @@ -359,7 +359,7 @@ "component": "Dropdown", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/dropdown.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/dropdown_preview/default/", "parameters": [ { "name": "overlay", @@ -385,7 +385,7 @@ "component": "HiddenTextExpander", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/hidden_text_expander.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/hidden_text_expander_preview/default/", "parameters": [ { "name": "inline", @@ -411,7 +411,7 @@ "component": "Image", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_preview/default/", "parameters": [ { "name": "src", @@ -443,7 +443,7 @@ "component": "ImageCrop", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/image_crop.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/image_crop_preview/default/", "parameters": [ { "name": "src", @@ -469,7 +469,7 @@ "component": "Layout", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/layout.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/layout_preview/default/", "parameters": [ { "name": "stacking_breakpoint", @@ -501,7 +501,7 @@ "component": "Menu", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/menu.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/menu_preview/default/", "parameters": [ { "name": "system_arguments", @@ -515,7 +515,7 @@ "component": "NavList", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list_preview/default/", "parameters": [ { "name": "selected_item_id", @@ -535,7 +535,7 @@ "component": "NavList::Item", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/item.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/item_preview/default/", "parameters": [ { "name": "selected_item_id", @@ -573,7 +573,7 @@ "component": "NavList::Section", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/nav_list/section.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/nav_list/section_preview/default/", "parameters": [ { "name": "selected_item_id", @@ -593,7 +593,7 @@ "component": "SegmentedControl", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/segmented_control.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/segmented_control_preview/default/", "parameters": [ { "name": "hide_labels", @@ -625,7 +625,7 @@ "component": "TabNav", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_nav.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_nav_preview/default/", "parameters": [ { "name": "tag", @@ -657,7 +657,7 @@ "component": "TabPanels", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tab_panels.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tab_panels_preview/default/", "parameters": [ { "name": "label", @@ -695,7 +695,7 @@ "component": "TextField", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/text_field.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/text_field_preview/default/", "parameters": [ { "name": "name", @@ -829,7 +829,7 @@ "component": "ToggleSwitch", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/toggle_switch.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/toggle_switch_preview/default/", "parameters": [ { "name": "src", @@ -879,7 +879,7 @@ "component": "Tooltip", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/tooltip.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/tooltip_preview/default/", "parameters": [ { "name": "for_id", @@ -917,7 +917,7 @@ "component": "UnderlineNav", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_nav.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_nav_preview/default/", "parameters": [ { "name": "tag", @@ -955,7 +955,7 @@ "component": "UnderlinePanels", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/alpha/underline_panels.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/alpha/underline_panels_preview/default/", "parameters": [ { "name": "label", @@ -993,7 +993,7 @@ "component": "AutoComplete", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete_preview/default/", "parameters": [ { "name": "label_text", @@ -1091,7 +1091,7 @@ "component": "AutoComplete::Item", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/auto_complete/item.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/auto_complete/item_preview/default/", "parameters": [ { "name": "value", @@ -1135,7 +1135,7 @@ "component": "Avatar", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_preview/default/", "parameters": [ { "name": "src", @@ -1179,7 +1179,7 @@ "component": "AvatarStack", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/avatar_stack.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/avatar_stack_preview/default/", "parameters": [ { "name": "tag", @@ -1217,7 +1217,7 @@ "component": "BaseButton", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/base_button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/base_button_preview/default/", "parameters": [ { "name": "tag", @@ -1249,7 +1249,7 @@ "component": "Blankslate", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/blankslate.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/blankslate_preview/default/", "parameters": [ { "name": "narrow", @@ -1281,7 +1281,7 @@ "component": "BorderBox", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box_preview/default/", "parameters": [ { "name": "padding", @@ -1301,7 +1301,7 @@ "component": "BorderBox::Header", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/border_box/header.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/border_box/header_preview/default/", "parameters": [ { "name": "system_arguments", @@ -1315,7 +1315,7 @@ "component": "Breadcrumbs", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/breadcrumbs.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/breadcrumbs_preview/default/", "parameters": [ { "name": "system_arguments", @@ -1329,7 +1329,7 @@ "component": "Button", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_preview/default/", "parameters": [ { "name": "scheme", @@ -1379,7 +1379,7 @@ "component": "ButtonGroup", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/button_group.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/button_group_preview/default/", "parameters": [ { "name": "variant", @@ -1405,7 +1405,7 @@ "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/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/clipboard_copy_preview/default/", "parameters": [ { "name": "aria-label", @@ -1437,7 +1437,7 @@ "component": "CloseButton", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/close_button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/close_button_preview/default/", "parameters": [ { "name": "type", @@ -1457,7 +1457,7 @@ "component": "Counter", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/counter.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/counter_preview/default/", "parameters": [ { "name": "count", @@ -1507,7 +1507,7 @@ "component": "Details", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/details.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/details_preview/default/", "parameters": [ { "name": "overlay", @@ -1533,7 +1533,7 @@ "component": "Flash", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/flash.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/flash_preview/default/", "parameters": [ { "name": "full", @@ -1577,7 +1577,7 @@ "component": "Heading", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/heading.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/heading_preview/default/", "parameters": [ { "name": "tag", @@ -1597,7 +1597,7 @@ "component": "IconButton", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/icon_button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/icon_button_preview/default/", "parameters": [ { "name": "icon", @@ -1671,7 +1671,7 @@ "component": "Label", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/label.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/label_preview/default/", "parameters": [ { "name": "tag", @@ -1715,7 +1715,7 @@ "component": "Link", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/link.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/link_preview/default/", "parameters": [ { "name": "tag", @@ -1759,7 +1759,7 @@ "component": "Markdown", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/markdown.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/markdown_preview/default/", "parameters": [ { "name": "tag", @@ -1779,7 +1779,7 @@ "component": "Octicon", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/octicon.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/octicon/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/octicon_preview/default/", "parameters": [ { "name": "icon_name", @@ -1817,7 +1817,7 @@ "component": "Popover", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/popover.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/popover/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/popover_preview/default/", "parameters": [ { "name": "system_arguments", @@ -1831,7 +1831,7 @@ "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/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/progress_bar_preview/default/", "parameters": [ { "name": "size", @@ -1851,7 +1851,7 @@ "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/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/relative_time_preview/default/", "parameters": [ { "name": "datetime", @@ -1961,7 +1961,7 @@ "component": "Text", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/text.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/text_preview/default/", "parameters": [ { "name": "tag", @@ -1981,7 +1981,7 @@ "component": "Truncate", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/beta/truncate.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/beta/truncate_preview/default/", "parameters": [ { "name": "system_arguments", @@ -1995,7 +1995,7 @@ "component": "Box", "status": "stable", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/box.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/box_preview/default/", "parameters": [ { "name": "system_arguments", @@ -2009,7 +2009,7 @@ "component": "Button", "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/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/button_preview/default/", "parameters": [ { "name": "scheme", @@ -2071,7 +2071,7 @@ "component": "DropdownMenu", "status": "deprecated", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/dropdown_menu_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown_menu/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/dropdown_menu_preview/default/", "parameters": [ { "name": "direction", @@ -2103,7 +2103,7 @@ "component": "HellipButton", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/hellip_button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/hellip_button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/hellip_button_preview/default/", "parameters": [ { "name": "inline", @@ -2123,7 +2123,7 @@ "component": "IconButton", "status": "deprecated", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/icon_button.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/icon_button_preview/default/", "parameters": [ { "name": "scheme", @@ -2185,7 +2185,7 @@ "component": "Layout", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/layout_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/layout_preview/default/", "parameters": [ { "name": "responsive", @@ -2217,7 +2217,7 @@ "component": "LocalTime", "status": "deprecated", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/local_time.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/local_time_preview/default/", "parameters": [ { "name": "datetime", @@ -2291,7 +2291,7 @@ "component": "Navigation::Tab", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/navigation/tab_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/navigation/tab_preview/default/", "parameters": [ { "name": "list", @@ -2341,7 +2341,7 @@ "component": "OcticonSymbols", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/octicon_symbols_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon_symbols/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/octicon_symbols_preview/default/", "parameters": [ { "name": "icons", @@ -2355,7 +2355,7 @@ "component": "Spinner", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/spinner_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/spinner/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/spinner_preview/default/", "parameters": [ { "name": "size", @@ -2381,7 +2381,7 @@ "component": "State", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/state_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/state/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/state_preview/default/", "parameters": [ { "name": "title", @@ -2419,7 +2419,7 @@ "component": "Subhead", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/subhead_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/subhead/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/subhead_preview/default/", "parameters": [ { "name": "spacious", @@ -2445,7 +2445,7 @@ "component": "TabContainer", "status": "alpha", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tab_container_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tab_container/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tab_container_preview/default/", "parameters": [ { "name": "system_arguments", @@ -2457,9 +2457,9 @@ }, { "component": "TimeAgo", - "status": "beta", + "status": "deprecated", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/time_ago_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/time_ago_preview/default/", "parameters": [ { "name": "time", @@ -2485,7 +2485,7 @@ "component": "TimelineItem", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/timeline_item_component.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/timeline_item/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/timeline_item_preview/default/", "parameters": [ { "name": "condensed", @@ -2505,7 +2505,7 @@ "component": "Tooltip", "status": "deprecated", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/tooltip.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/tooltip_preview/default/", "parameters": [ { "name": "label", @@ -2549,7 +2549,7 @@ "component": "Truncate", "status": "beta", "source": "https://github.com/primer/view_components/tree/main/app/components/primer/truncate.rb", - "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate/default/", + "lookbook": "https://primer.style/view-components/lookbook/inspect/primer/truncate_preview/default/", "parameters": [ { "name": "tag", diff --git a/static/statuses.json b/static/statuses.json index c76d023b57..36b05e2aec 100644 --- a/static/statuses.json +++ b/static/statuses.json @@ -90,7 +90,7 @@ "Primer::StateComponent": "beta", "Primer::SubheadComponent": "beta", "Primer::TabContainerComponent": "alpha", - "Primer::TimeAgoComponent": "beta", + "Primer::TimeAgoComponent": "deprecated", "Primer::TimelineItemComponent": "beta", "Primer::TimelineItemComponent::BadgeComponent": "alpha", "Primer::Tooltip": "deprecated",