-
Notifications
You must be signed in to change notification settings - Fork 639
Remove support for sx
from CircleBadge
component
#6673
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
🦋 Changeset detectedLatest commit: 9f01823 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 |
👋 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! |
size-limit report 📦
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request removes the deprecated sx
prop support from the CircleBadge
component as part of a broader effort to eliminate sx
usage across Primer React components. The change is part of a major version release with an existing migration strategy in place.
Key changes:
- Removes
sx
prop support fromCircleBadge
component type definitions and styling - Updates component documentation to reflect the removed prop
- Updates test snapshots to reflect the styling changes
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
File | Description |
---|---|
packages/react/src/CircleBadge/CircleBadge.tsx |
Removes sx prop from component interface and styled component implementation |
packages/react/src/CircleBadge/CircleBadge.docs.json |
Removes sx prop from component documentation |
packages/react/src/CircleBadge/__snapshots__/CircleBadge.test.tsx.snap |
Updates test snapshots to reflect new CSS class names after sx removal |
.changeset/cool-apricots-sneeze.md |
Adds changeset entry documenting the breaking change for major version release |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like CircleBadge is still a styled component 🤔 , though it is up for deprecation, I'm not sure if we care to migrate? cc @TylerJDev
Also, let's make sure to run integration checks before merging
Tyler confirmed in the issue comments that we should just migrate this one, since the removal might not happen in v38 👍 |
should we migrate it to css modules then? |
👋 Hi from github/github-ui! Your integration PR is ready: https://github.com/github/github-ui/pull/3086 |
🟢 ci completed with status |
👋 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! |
…/no-sx-CircleBadge
👋 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! |
Closes https://github.com/github/primer/issues/5780
Current
sx
usage: 5✅
sx
usages are only in repos other than github-ui; those usages have been added to the tracking issueChangelog
Removed
Remove support for
sx
from theCircleBadge
component, and associated stories, docs, and testsRollout strategy
We are using the
@primer/styled-react
component to mitigate removingsx
usage. We will make sure usage is updated upstream before merging.Merge checklist