chore: remove sx from Overlay

[francinelucca]

Closes #6769

Current sx usage: 5

✅ sx usages are only in repos other than github-ui; those usages have been added to the tracking issue

Changelog

Removed

Remove support for sx from the CircleBadge component, and associated stories, docs, and tests

Rollout strategy

• Patch release
• Minor release
• Major release; if selected, include a written rollout or migration plan
• None; if selected, include a brief description as to why

Testing & Reviewing

Merge checklist

• Added/updated tests
• Added/updated documentation
• Added/updated previews (Storybook)
• Changes are SSR compatible
• Tested in Chrome
• Tested in Firefox
• Tested in Safari
• Tested in Edge
• (GitHub staff only) Integration tests pass at github/github (Learn more about how to run integration tests)

[changeset-bot]

🦋 Changeset detected

Latest commit: 8b95e0f

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]

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

[primer-integration]

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

[primer-integration]

🟢 ci completed with status success.

[francinelucca]

will need https://github.com/github/github-ui/pull/3154/commits/8e5a761a0a6ac4f035fded148214fb8fa394070e

[Copilot]

Pull Request Overview

This PR removes the deprecated sx prop support from the Overlay component as part of the migration away from styled-components. The change involves updating the main Overlay component to no longer accept sx props and creating styled-components wrappers in the @primer/styled-react package to maintain backwards compatibility.

• Remove sx prop support and SxProp type from the main Overlay component
• Create styled-components wrappers for Overlay, ActionMenu.Overlay, and Autocomplete.Overlay in the styled-react package
• Update stories, tests, and documentation to reflect the removal of sx support

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/react/src/Overlay/Overlay.tsx	Remove sx prop support and SxProp type, replace BoxWithFallback with direct component rendering
packages/styled-react/src/components/Overlay.tsx	Create styled-components wrapper for Overlay with sx support
packages/styled-react/src/components/Autocomplete.tsx	Create styled-components wrapper for Autocomplete with sx-enabled Overlay
packages/styled-react/src/components/ActionMenu.tsx	Create styled-components wrapper for ActionMenu with sx-enabled Overlay
packages/styled-react/src/index.tsx	Update exports to include new styled components
packages/react/src/Overlay/Overlay.features.stories.tsx	Replace sx usage with style prop
packages/react/src/Overlay/Overlay.dev.stories.tsx	Remove SxProps story
packages/react/src/Overlay/Overlay.docs.json	Remove sx prop from documentation
e2e/components/Overlay.test.ts	Remove SX Props test
.changeset/lazy-gifts-join.md	Add changeset for major version bump

[Copilot]

The sx utility and SxProp type are being imported from @primer/react, but according to the PR changes, sx support is being removed from the main package. These should be imported from a local sx module like in the other styled components.

Suggested change

	import {Overlay as PrimerOverlay, type OverlayProps as PrimerOverlayProps, sx, type SxProp} from '@primer/react'
	import styled from 'styled-components'
	import {type ForwardRefComponent} from '../polymorphic'
	import {Overlay as PrimerOverlay, type OverlayProps as PrimerOverlayProps} from '@primer/react'
	import styled from 'styled-components'
	import {type ForwardRefComponent} from '../polymorphic'
	import {sx, type SxProp} from '../sx'

[Copilot]

[nitpick] Inconsistent import pattern - this file imports sx and SxProp from ../sx, while the Overlay component imports them from @primer/react. All styled components should use the same import source for consistency.

Suggested change

	import {sx, type SxProp} from '../sx'
	import {sx, type SxProp} from '@primer/react'

[github-actions]

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