Remove `sx` props and `BoxWithFallback` from `TooltipV2` and `Tooltip` by liuliu-dev · Pull Request #6667 · primer/react

liuliu-dev · 2025-08-25T20:33:03Z

Wait until this PR is merged in github-ui: https://github.com/github/github-ui/pull/3366

Closes#5769
0 repo are still using sx props with Tooltip .

Changelog

Removed

Removed sx props from deprecated Tooltip and TooltipV2

Rollout strategy

Major release; if selected, include a written rollout or migration plan

changeset-bot · 2025-08-25T20:33:08Z

🦋 Changeset detected

Latest commit: e7d506a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@primer/react	Major
@primer/styled-react	Major

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 · 2025-08-25T20:33:32Z

👋 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!

github-actions · 2025-08-25T20:37:09Z

size-limit report 📦

Path	Size
packages/react/dist/browser.esm.js	89.86 KB (+0.02% 🔺)
packages/react/dist/browser.umd.js	89.95 KB (-0.06% 🔽)

Copilot

Pull Request Overview

This PR removes the deprecated sx prop support from both Tooltip and TooltipV2 components as part of a major release. The changes align with the design system's move away from styled-system props in favor of more maintainable styling approaches.

Key Changes

Removed sx prop from both Tooltip and TooltipV2 component type definitions
Replaced BoxWithFallback with native span element in TooltipV2
Cleaned up styled-components integration in legacy Tooltip

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
`packages/react/src/TooltipV2/Tooltip.tsx`	Removed `SxProp` import and type, replaced `BoxWithFallback` with `span`
`packages/react/src/TooltipV2/Tooltip.docs.json`	Removed `sx` prop from component documentation
`packages/react/src/Tooltip/Tooltip.tsx`	Removed `SxProp` type and `sx` function from styled-component
`packages/react/src/Tooltip/Tooltip.docs.json`	Removed `sx` prop from component documentation
`.changeset/pink-rockets-win.md`	Added changeset entry for major version bump

hectahertz

🚀

francinelucca

✨

francinelucca · 2025-09-26T01:56:01Z

+const Tooltip: ForwardRefExoticComponent<TooltipProps & RefAttributes<HTMLDivElement>> = forwardRef<
+ HTMLDivElement,
+ TooltipProps
+>(function Tooltip(props, ref) {
+ return <Box as={PrimerTooltip} ref={ref} {...props} />
+})
+
+export {Tooltip, type TooltipProps}
+
+type DeprecatedTooltipProps = PrimerDeprecatedTooltipProps & SxProp
+
+function DeprecatedTooltip(props: DeprecatedTooltipProps) {
+ return <Box as={PrimerDeprecatedTooltip} {...props} />
+}


should we do the new as hack just in case? I think in theory it affects every component

I think this only affects polymorphic components that take an as prop, Tooltip isn’t one of them, so it should be fine.
I tested it in primer-react.browser.test.tsx and confirmed that the props and children are passed correctly for Tooltip.

ah got it, thanks! ❤️

github-actions · 2025-09-30T22:58:56Z

👋 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 · 2025-09-30T23:09:58Z

👋 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!

primer-integration · 2025-09-30T23:21:37Z

👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/3596

primer-integration · 2025-10-01T00:55:51Z

🟢 ci completed with status success.

liuliu-dev added 2 commits August 25, 2025 13:29

remove sx props and BoxWithFallback from tooltip
635b765

changeset
3a9dfe6

github-actionsBot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Aug 25, 2025

liuliu-dev deployed to github-pages August 25, 2025 20:42 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 August 25, 2025 20:42 Inactive

Merge branch 'main' into liuliu/migrate-tooltip
80df4ba

liuliu-dev deployed to github-pages August 26, 2025 21:14 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 August 26, 2025 21:14 Inactive

liuliu-dev deployed to github-pages August 26, 2025 21:39 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 August 26, 2025 21:39 Inactive

Merge branch 'main' into liuliu/migrate-tooltip
925c38e

liuliu-dev deployed to github-pages August 26, 2025 22:01 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 August 26, 2025 22:01 Inactive

liuliu-dev marked this pull request as ready for review August 26, 2025 22:47

CopilotAI review requested due to automatic review settings August 26, 2025 22:47

liuliu-dev requested a review from a team as a code owner August 26, 2025 22:47

liuliu-dev requested a review from hectahertz August 26, 2025 22:47

CopilotAI reviewed Aug 26, 2025
View reviewed changes

hectahertz approved these changes Sep 2, 2025
View reviewed changes

liuliu-dev added 4 commits September 10, 2025 15:23

Merge remote-tracking branch 'origin/main' into liuliu/migrate-tooltip
a3639d6

wip
60480e0

Merge branch 'main' into liuliu/migrate-tooltip
1875bfc

resolve conflicts
a82cc87

github-actionsBottemporarily deployed to storybook-preview-6667 September 16, 2025 21:36 Inactive

revert package json changes
d2d95ad

github-actionsBot requested a deployment to storybook-preview-6667 September 16, 2025 21:40 Abandoned

match main branch
1d73e09

github-actionsBot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: failing Changes in this PR cause breaking changes in gh/gh labels Sep 25, 2025

liuliu-dev requested review from a team and hectahertz September 25, 2025 23:02

francinelucca approved these changes Sep 26, 2025
View reviewed changes

liuliu-dev changed the title ~~Remove sx props and BoxWithFallback from TooltipV2 and Tooltip~~DO NOT MERGE:Remove sx props and BoxWithFallback from TooltipV2 and TooltipSep 26, 2025

conflicts
9bcf039

github-actionsBot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 30, 2025

liuliu-dev deployed to github-pages September 30, 2025 23:08 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 September 30, 2025 23:08 Inactive

ci fix
e7d506a

github-actionsBot added integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Sep 30, 2025

liuliu-dev deployed to github-pages September 30, 2025 23:17 — with GitHub Actions View deployment

github-actionsBottemporarily deployed to storybook-preview-6667 September 30, 2025 23:18 Inactive

github-actionsBot removed the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 30, 2025

github-actionsBot added integration-tests: failing Changes in this PR cause breaking changes in gh/gh and removed integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh labels Sep 30, 2025

github-actionsBot added integration-tests: passing Changes in this PR do NOT cause breaking changes in gh/gh and removed integration-tests: failing Changes in this PR cause breaking changes in gh/gh labels Oct 1, 2025

liuliu-dev added this pull request to the merge queue Oct 1, 2025

francinelucca changed the title ~~DO NOT MERGE:Remove sx props and BoxWithFallback from TooltipV2 and Tooltip~~Remove sx props and BoxWithFallback from TooltipV2 and TooltipOct 1, 2025

Merged via the queue into main with commit d122122Oct 1, 2025
44 checks passed

liuliu-dev deleted the liuliu/migrate-tooltip branch October 1, 2025 01:09

primerBot mentioned this pull request Oct 1, 2025
Release tracking (rc) #6913
Merged

Uh oh!

Conversation

liuliu-dev commented Aug 25, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Removed

Rollout strategy

Uh oh!

changeset-botBot commented Aug 25, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actionsBot commented Aug 25, 2025

Uh oh!

github-actionsBot commented Aug 25, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

hectahertz left a comment

Choose a reason for hiding this comment

Uh oh!

francinelucca left a comment

Choose a reason for hiding this comment

Uh oh!

francineluccaSep 26, 2025

Choose a reason for hiding this comment

Uh oh!

liuliu-devSep 26, 2025

Choose a reason for hiding this comment

Uh oh!

francineluccaSep 26, 2025

Choose a reason for hiding this comment

Uh oh!

github-actionsBot commented Sep 30, 2025

Uh oh!

github-actionsBot commented Sep 30, 2025

Uh oh!

primer-integrationBot commented Sep 30, 2025

Uh oh!

primer-integrationBot commented Oct 1, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

liuliu-dev commented Aug 25, 2025•
edited
Loading

changeset-botBot commented Aug 25, 2025•
edited
Loading

github-actionsBot commented Aug 25, 2025•
edited
Loading