feat(RelativeTime): remove support for sx prop#6827
Merged
francinelucca merged 7 commits intoSep 22, 2025
Conversation
🦋 Changeset detectedLatest commit: 593bc3a The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
Bot
added
staff
Contributor
|
👋 Hi, this pull request contains changes to the source code that github/github depends on. If you are GitHub staff, we recommend testing these changes with github/github using the integration workflow. Thanks! |
Contributor
size-limit report 📦
|
joshblack
marked this pull request as ready for review
September 10, 2025 22:13
joshblack
requested review from
Copilot and
francinelucca
and removed request for
francinelucca
September 10, 2025 22:13
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes support for the sx prop from the RelativeTime component as part of a migration strategy to eliminate styled-components dependencies. The changes include removing sx prop type definitions, updating component creation utilities, and adjusting Storybook configurations.
- Remove
sxprop support fromRelativeTimecomponent - Refactor component creation utilities to eliminate styled-components dependency
- Update Storybook controls to exclude sx-related properties
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/styled-react/src/index.tsx | Adds RelativeTime wrapper with sx support to maintain backward compatibility in styled-react package |
| packages/react/src/utils/create-component.ts | Removes styled-components and sx dependencies from component creation utility |
| packages/react/src/RelativeTime/RelativeTime.stories.tsx | Updates Storybook controls to exclude sx prop |
| packages/react/src/RelativeTime/RelativeTime.features.stories.tsx | Updates Storybook controls to exclude sx prop |
| packages/react/src/RelativeTime/RelativeTime.docs.json | Removes sx prop from component documentation |
| .changeset/short-cloths-deny.md | Documents the breaking change for version release |
francinelucca
approved these changes
Sep 11, 2025
…rt-for-sx-from-relative-time
|
👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/2639 |
|
🟢 ci completed with status |
github-actions
Bot
added
integration-tests: passing
francinelucca
enabled auto-merge
September 22, 2025 18:59
github-actions
Bot
added
the
integration-tests: recommended
Contributor
|
👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks! |
github-actions
Bot
removed
the
integration-tests: recommended
Contributor
|
👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks! |
github-actions
Bot
added
the
integration-tests: recommended
github-actions
Bot
added
integration-tests: recommended
Contributor
|
👋 Hi, there are new commits since the last successful integration test. We recommend running the integration workflow once more, unless you are sure the new changes do not affect github/github. Thanks! |
github-actions
Bot
requested a deployment
to
storybook-preview-6827
September 22, 2025 19:15
Abandoned
francinelucca
deleted the
6773-remove-support-for-sx-from-relative-time
branch
September 22, 2025 19:31
Merged
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 7, 2026
…nts to Private/ namespace
Add packages/react/src/Timeline/internal/timelineStoryHelpers.{tsx,module.css}
with six story-only helpers (VariantSection, RealisticTimeline, Examples,
BoldLink, InlineAvatar, MutedTime) for the Timeline event-story surfaces to
share. Never exported from the package index (stories don't ship), so no public
API surface. BoldLink/InlineAvatar/MutedTime shim live-GitHub styling Primer
doesn't express yet (tracked in github/primer#6826/#6827/#6828).
Retitle the Comments stories to Private/Components/Timeline/Events/Comments and
consume the shared VariantSection + RealisticTimeline. Pure refactor — Storybook
rendering unchanged.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 7, 2026
Swap the Code Scanning story's local scaffolding for the shared internal helpers in ./internal/timelineStoryHelpers: VariantSection (captioned section), Examples / RealisticTimeline (wrappers), BoldLink (#6826), InlineAvatar (#6827), and MutedTime (#6828). EventFixed has no in-text links, so it uses the no-links RealisticTimeline wrapper; the link-bearing groups keep Examples. Delete the now-duplicated local classes (.Variant, .VariantLabel, .RealisticTimeline, .LinkWithBoldStyle, .InlineAvatar, .Timestamp). Pure refactor — no rendered output change; the workflow sub-row icon label and tool-version Label are untouched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 7, 2026
…nts to Private/ namespace
Add packages/react/src/Timeline/internal/timelineStoryHelpers.{tsx,module.css}
with six story-only helpers (VariantSection, RealisticTimeline, Examples,
BoldLink, InlineAvatar, MutedTime) for the Timeline event-story surfaces to
share. Never exported from the package index (stories don't ship), so no public
API surface. BoldLink/InlineAvatar/MutedTime shim live-GitHub styling Primer
doesn't express yet (tracked in github/primer#6826/#6827/#6828).
Retitle the Comments stories to Private/Components/Timeline/Events/Comments and
consume the shared VariantSection + RealisticTimeline. Pure refactor — Storybook
rendering unchanged.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 7, 2026
Swap the Code Scanning story's local scaffolding for the shared internal helpers in ./internal/timelineStoryHelpers: VariantSection (captioned section), Examples / RealisticTimeline (wrappers), BoldLink (#6826), InlineAvatar (#6827), and MutedTime (#6828). EventFixed has no in-text links, so it uses the no-links RealisticTimeline wrapper; the link-bearing groups keep Examples. Delete the now-duplicated local classes (.Variant, .VariantLabel, .RealisticTimeline, .LinkWithBoldStyle, .InlineAvatar, .Timestamp). Pure refactor — no rendered output change; the workflow sub-row icon label and tool-version Label are untouched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
10 tasks
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 8, 2026
Swap the Code Scanning story's local scaffolding for the shared internal helpers in ./internal/timelineStoryHelpers: VariantSection (captioned section), Examples / RealisticTimeline (wrappers), BoldLink (#6826), InlineAvatar (#6827), and MutedTime (#6828). EventFixed has no in-text links, so it uses the no-links RealisticTimeline wrapper; the link-bearing groups keep Examples. Delete the now-duplicated local classes (.Variant, .VariantLabel, .RealisticTimeline, .LinkWithBoldStyle, .InlineAvatar, .Timestamp). Pure refactor — no rendered output change; the workflow sub-row icon label and tool-version Label are untouched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
janmaarten-a11y
added a commit
that referenced
this pull request
Jul 8, 2026
Swap the Code Scanning story's local scaffolding for the shared internal helpers in ./internal/timelineStoryHelpers: VariantSection (captioned section), Examples / RealisticTimeline (wrappers), BoldLink (#6826), InlineAvatar (#6827), and MutedTime (#6828). EventFixed has no in-text links, so it uses the no-links RealisticTimeline wrapper; the link-bearing groups keep Examples. Delete the now-duplicated local classes (.Variant, .VariantLabel, .RealisticTimeline, .LinkWithBoldStyle, .InlineAvatar, .Timestamp). Pure refactor — no rendered output change; the workflow sub-row icon label and tool-version Label are untouched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #6773
Changelog
New
Changed
Removed
sxfromRelativeTimeRollout strategy
This component has no
sxusage in github-ui and can be safely migrated