Breadcrumbs: Remove `sx` from component #6844

TylerJDev · 2025-09-12T16:13:58Z

Closes https://github.com/github/primer/issues/5840

Removes sx support in Breadcrumbs

Changelog

Removed

Removes sx in Breadrcrumbs

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 · 2025-09-12T16:14:02Z

🦋 Changeset detected

Latest commit: 0d08da1

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-09-12T16:48:59Z

👋 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-09-12T16:52:43Z

size-limit report 📦

Path	Size
packages/react/dist/browser.esm.js	89.52 KB (-0.01% 🔽)
packages/react/dist/browser.umd.js	89.63 KB (+0.02% 🔺)

Copilot

Pull Request Overview

This PR removes sx prop support from the Breadcrumbs component as part of a broader effort to migrate away from styled-components and the sx styling system. The component now uses standard CSS properties via a style prop instead.

Key changes:

Removed sx prop support from both Breadcrumbs and Breadcrumbs.Item components
Replaced BoxWithFallback wrapper with native HTML elements (nav and a)
Updated TypeScript interfaces to use style prop instead of SxProp

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/react/src/Breadcrumbs/Breadcrumbs.tsx	Main component refactor removing sx support and BoxWithFallback dependency
packages/styled-react/src/index.tsx	Removed Breadcrumbs export from styled-react package
packages/styled-react/src/tests/primer-react.browser.test.tsx	Removed sx prop tests for Breadcrumbs components
packages/styled-react/src/tests/snapshots/exports.test.ts.snap	Updated export snapshot to exclude Breadcrumbs
.changeset/slimy-parrots-love.md	Added changeset documenting the breaking change

packages/react/src/Breadcrumbs/Breadcrumbs.tsx

packages/styled-react/src/__tests__/primer-react.browser.test.tsx

…eadcrumbs

primer-integration · 2025-09-30T04:10:03Z

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

primer-integration · 2025-09-30T04:38:37Z

🟢 ci completed with status success.

github-actions · 2025-09-30T04:59:11Z

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

pksjce · 2025-09-30T05:38:46Z

packages/react/src/Breadcrumbs/Breadcrumbs.tsx

+      {...rest}
+    />
+  )
+}


Remove sx from Breadcrumbs

4bb272f

TylerJDev added 2 commits September 12, 2025 12:47

Remove PolymorphicForwardRefComponent

2375626

Merge branch 'main' into remove-sx-from-breadcrumbs

4d83e1b

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

TylerJDev deployed to github-pages September 12, 2025 16:57 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 12, 2025 16:57 Inactive

Remove from styled-react

b2e1ac2

TylerJDev deployed to github-pages September 12, 2025 17:44 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 12, 2025 17:44 Inactive

pksjce self-requested a review September 15, 2025 05:19

Merge branch 'main' into remove-sx-from-breadcrumbs

5be4f2e

TylerJDev deployed to github-pages September 16, 2025 16:12 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 16, 2025 16:12 Inactive

Run format

b13d97d

TylerJDev deployed to github-pages September 19, 2025 17:15 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 19, 2025 17:16 Inactive

TylerJDev added 2 commits September 23, 2025 11:32

Remove css for story

8f2a9f3

Add changeset

a514560

github-actions bot temporarily deployed to storybook-preview-6844 September 23, 2025 15:41 Inactive

TylerJDev deployed to github-pages September 23, 2025 15:49 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 23, 2025 15:51 Inactive

TylerJDev marked this pull request as ready for review September 23, 2025 15:53

TylerJDev requested a review from a team as a code owner September 23, 2025 15:53

Copilot AI review requested due to automatic review settings September 23, 2025 15:53

Copilot AI reviewed Sep 23, 2025

View reviewed changes

packages/react/src/Breadcrumbs/Breadcrumbs.tsx Show resolved Hide resolved

pksjce approved these changes Sep 25, 2025

View reviewed changes

packages/react/src/Breadcrumbs/Breadcrumbs.tsx Show resolved Hide resolved

packages/styled-react/src/__tests__/primer-react.browser.test.tsx Show resolved Hide resolved

Merge branch 'main' of github.com:primer/react into remove-sx-from-br…

adfc912

…eadcrumbs

github-actions bot added the integration-tests: failing Changes in this PR cause breaking changes in gh/gh label Sep 25, 2025

fix export

d12d8ff

francinelucca deployed to github-pages September 25, 2025 23:14 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 25, 2025 23:14 Inactive

modify test

98a37c3

francinelucca deployed to github-pages September 26, 2025 14:18 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 26, 2025 14:21 Inactive

francinelucca added 4 commits September 29, 2025 21:53

fix types.

ee2e4bb

fix types

a6196d0

Merge branch 'main' of github.com:primer/react into remove-sx-from-br…

338d1a2

…eadcrumbs

eslint fix

029cd7a

github-actions bot requested a deployment to storybook-preview-6844 September 30, 2025 04:01 Abandoned

francinelucca deployed to github-pages September 30, 2025 04:09 — with GitHub Actions View deployment

github-actions bot temporarily deployed to storybook-preview-6844 September 30, 2025 04:09 Inactive

github-actions bot 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 30, 2025

remove wrapping

0d08da1

github-actions bot 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

francinelucca requested a review from pksjce September 30, 2025 05:01

francinelucca deployed to github-pages September 30, 2025 05:07 — with GitHub Actions View deployment

github-actions bot deployed to storybook-preview-6844 September 30, 2025 05:07 View deployment

pksjce approved these changes Sep 30, 2025

View reviewed changes

packages/react/src/Breadcrumbs/Breadcrumbs.tsx

{...rest}

/>

)

}

Copy link

Contributor

pksjce Sep 30, 2025

Choose a reason for hiding this comment

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

👍

francinelucca added this pull request to the merge queue Sep 30, 2025

Merged via the queue into main with commit 1f9f582 Sep 30, 2025
42 checks passed

francinelucca deleted the remove-sx-from-breadcrumbs branch September 30, 2025 14:55

primer bot mentioned this pull request Sep 30, 2025

Release tracking (rc) #6913

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Breadcrumbs: Remove `sx` from component #6844

Breadcrumbs: Remove `sx` from component #6844

TylerJDev commented Sep 12, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Sep 12, 2025 •

edited

Loading

Uh oh!

github-actions bot commented Sep 12, 2025

Uh oh!

github-actions bot commented Sep 12, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

primer-integration bot commented Sep 30, 2025

Uh oh!

primer-integration bot commented Sep 30, 2025

Uh oh!

github-actions bot commented Sep 30, 2025

Uh oh!

pksjce Sep 30, 2025

Uh oh!

Uh oh!

Uh oh!

Breadcrumbs: Remove sx from component #6844

Breadcrumbs: Remove sx from component #6844

Conversation

TylerJDev commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Removed

Rollout strategy

Testing & Reviewing

Merge checklist

Uh oh!

changeset-bot bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Sep 12, 2025

Uh oh!

github-actions bot commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

primer-integration bot commented Sep 30, 2025

Uh oh!

primer-integration bot commented Sep 30, 2025

Uh oh!

github-actions bot commented Sep 30, 2025

Uh oh!

pksjce Sep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Breadcrumbs: Remove `sx` from component #6844

Breadcrumbs: Remove `sx` from component #6844

TylerJDev commented Sep 12, 2025 •

edited

Loading

changeset-bot bot commented Sep 12, 2025 •

edited

Loading

github-actions bot commented Sep 12, 2025 •

edited

Loading