Skip to content

Remove support for sx from Checkbox component - #6654

Merged
llastflowers merged 11 commits into
mainfrom
llastflowers/5759/no-sx-Checkbox
Sep 22, 2025
Merged

Remove support for sx from Checkbox component#6654
llastflowers merged 11 commits into
mainfrom
llastflowers/5759/no-sx-Checkbox

Conversation

@llastflowers

@llastflowersllastflowers commented Aug 22, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

Closeshttps://github.com/github/primer/issues/5759

Current sx usage: 2

✅ 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 Checkbox component, and associated stories, docs, and tests

Rollout strategy

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

We are using the @primer/styled-react component to mitigate removing sx usage. We will make sure usage is updated upstream before merging.

Merge checklist

@llastflowersllastflowers self-assigned this Aug 22, 2025
@changeset-bot

changeset-botBot commented Aug 22, 2025•
edited
Loading

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: dc92e80

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

This PR includes changesets to release 2 packages
NameType
@primer/reactMajor
@primer/styled-reactMajor

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

github-actionsBot commented Aug 22, 2025

Copy link
Copy Markdown
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!

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

github-actionsBot commented Aug 22, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize
packages/react/dist/browser.esm.js89.42 KB (-0.12% 🔽)
packages/react/dist/browser.umd.js89.54 KB (-0.09% 🔽)

@github-actions
github-actionsBot requested a deployment to storybook-preview-6654 August 22, 2025 21:44 Abandoned
@github-actions
github-actionsBottemporarily deployed to storybook-preview-6654 August 22, 2025 21:52 Inactive
@llastflowers
llastflowers marked this pull request as ready for review September 4, 2025 22:53
CopilotAI review requested due to automatic review settings September 4, 2025 22:53
@llastflowers
llastflowers requested a review from a team as a code ownerSeptember 4, 2025 22:53
CopilotAI reviewed Sep 4, 2025
View reviewed changes

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR removes the deprecated sx prop support from the Checkbox component as part of Primer React's migration away from styled-system. The change removes the sx prop from the component interface, eliminates the conditional rendering logic that wrapped the checkbox in a Box component when sx was present, and updates associated documentation and tests.

Key Changes:

  • Removed sx prop from CheckboxProps interface and component implementation
  • Simplified component rendering by removing conditional Box wrapper logic
  • Updated Storybook configuration and documentation to reflect the removed prop

Reviewed Changes

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

FileDescription
packages/react/src/Checkbox/Checkbox.tsxRemoved SxProp type, Box import, sx parameter, and conditional rendering logic
packages/react/src/Checkbox/Checkbox.stories.tsxRemoved sx from excluded control keys in Storybook configuration
packages/react/src/Checkbox/Checkbox.docs.jsonRemoved sx prop documentation entry
.changeset/tasty-cheetahs-pay.mdAdded changeset documenting the breaking change

@github-actions
github-actionsBottemporarily deployed to storybook-preview-6654 September 4, 2025 23:03 Inactive
@francinelucca

francinelucca commented Sep 5, 2025

Copy link
Copy Markdown
Member

Note: make sure to run integration checks 🙏

@github-actionsgithub-actionsBot added integration-tests: failing Changes in this PR cause breaking changes in gh/gh and removed integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm labels Sep 5, 2025
@github-actions
github-actionsBottemporarily deployed to storybook-preview-6654 September 5, 2025 20:42 Inactive
@llastflowersllastflowers removed the integration-tests: failing Changes in this PR cause breaking changes in gh/gh label Sep 5, 2025
@github-actionsgithub-actionsBot added integration-tests: failing Changes in this PR cause breaking changes in gh/gh and removed integration-tests: failing Changes in this PR cause breaking changes in gh/gh labels Sep 5, 2025
@github-actionsgithub-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 16, 2025
@github-actions

github-actionsBot commented Sep 16, 2025

Copy link
Copy Markdown
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
github-actionsBottemporarily deployed to storybook-preview-6654 September 16, 2025 21:44 Inactive
@github-actionsgithub-actionsBot removed the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 17, 2025
@github-actions

github-actionsBot commented Sep 17, 2025

Copy link
Copy Markdown
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-actionsgithub-actionsBot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 17, 2025
@github-actions
github-actionsBottemporarily deployed to storybook-preview-6654 September 17, 2025 20:02 Inactive
@github-actionsgithub-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 17, 2025
@github-actions

github-actionsBot commented Sep 17, 2025

Copy link
Copy Markdown
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
github-actionsBottemporarily deployed to storybook-preview-6654 September 17, 2025 20:14 Inactive
@github-actionsgithub-actionsBot removed the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Sep 17, 2025
@primer-integration

primer-integrationBot commented Sep 17, 2025

Copy link
Copy Markdown

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

@primer-integration

primer-integrationBot commented Sep 17, 2025

Copy link
Copy Markdown

🟢 ci completed with status success.

@llastflowers
llastflowers added this pull request to the merge queueSep 22, 2025
Merged via the queue into main with commit 513cc3fSep 22, 2025
43 checks passed
@llastflowers
llastflowers deleted the llastflowers/5759/no-sx-Checkbox branch September 22, 2025 17:24
@primerprimerBot mentioned this pull request Sep 22, 2025
Merged
janmaarten-a11y added a commit that referenced this pull request Jul 17, 2026
@janmaarten-a11y
Point data-* contract references atgithub/primer#6664, not the parit…
f580b33
…y epic
The data-* event contract (data-event-type / data-event-scope / data-actor-type)
is owned by github/primer#6664 (Phase 3), whose "category taxonomy and data-*
tagging" section is the actual deliverable. github/primer#6654 is the broad
parity epic, not the contract. Fix the citations in all six banners plus the
toEventDataAttributes serializer note, and relabel #6654 as the parent epic.
@janmaarten-a11yjanmaarten-a11y mentioned this pull request Jul 22, 2026
Closed
1 task
This was referenced Aug 19, 2026
Merged
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@francineluccafrancineluccafrancinelucca approved these changes

Assignees

@llastflowersllastflowers

Labels

integration-tests: passingChanges in this PR do NOT cause breaking changes in gh/gh

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@llastflowers@francinelucca