Skip to content

Breadcrumbs: refresh menu overflow items when children content changes #7999

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+46 −2
Draft

Breadcrumbs: refresh menu overflow items when children content changes #7999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e53d34d
Initial plan
Copilot Jun 16, 2026
19fe8bc
Fix Breadcrumbs overflow to refresh on child content changes
Copilot Jun 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/breadcrumbs-overflow-refresh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Breadcrumbs: Recalculate menu overflow items when breadcrumb content changes without changing the number of items.
4 changes: 2 additions & 2 deletions packages/react/src/Breadcrumbs/Breadcrumbs.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ function Breadcrumbs({className, children, style, overflow = 'wrap', variant = '
useResizeObserver(handleResize, containerRef)

useEffect(() => {
if ((overflow === 'menu' || overflow === 'menu-with-root') && childArray.length > 5 && menuItems.length === 0) {
if ((overflow === 'menu' || overflow === 'menu-with-root') && childArray.length > 5) {
const containerWidth = containerRef.current?.offsetWidth || 800
const result = calculateOverflow(containerWidth)

Expand All @@ -281,7 +281,7 @@ function Breadcrumbs({className, children, style, overflow = 'wrap', variant = '

setEffectiveHideRoot(result.effectiveHideRoot)
}
}, [overflow, childArray, calculateOverflow, menuItems.length])
}, [overflow, childArray, calculateOverflow])

const finalChildren = React.useMemo(() => {
if (overflow === 'wrap' || menuItems.length === 0) {
Expand Down
39 changes: 39 additions & 0 deletions packages/react/src/Breadcrumbs/__tests__/Breadcrumbs.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,45 @@ describe('Breadcrumbs', () => {
expect(screen.getByText('Item 6')).toBeInTheDocument()
})

it('updates overflow menu items when children change with same item count', async () => {
const user = userEvent.setup()
const {rerender} = renderWithTheme(
<Breadcrumbs overflow="menu">
<Breadcrumbs.Item href="/home">Old Home</Breadcrumbs.Item>
<Breadcrumbs.Item href="/category">Old Category</Breadcrumbs.Item>
<Breadcrumbs.Item href="/subcategory">Subcategory</Breadcrumbs.Item>
<Breadcrumbs.Item href="/product">Product</Breadcrumbs.Item>
<Breadcrumbs.Item href="/details">Details</Breadcrumbs.Item>
<Breadcrumbs.Item href="/reviews">Reviews</Breadcrumbs.Item>
</Breadcrumbs>,
)

const menuButton = screen.getByRole('button', {name: /more breadcrumb items/i})
await user.click(menuButton)

const oldMenu = menuButton.closest('details') as HTMLElement
expect(within(oldMenu).getByRole('link', {name: 'Old Home'})).toBeInTheDocument()

await user.click(menuButton)

rerender(
<Breadcrumbs overflow="menu">
<Breadcrumbs.Item href="/new-home">New Home</Breadcrumbs.Item>
<Breadcrumbs.Item href="/new-category">New Category</Breadcrumbs.Item>
<Breadcrumbs.Item href="/subcategory">Subcategory</Breadcrumbs.Item>
<Breadcrumbs.Item href="/product">Product</Breadcrumbs.Item>
<Breadcrumbs.Item href="/details">Details</Breadcrumbs.Item>
<Breadcrumbs.Item href="/reviews">Reviews</Breadcrumbs.Item>
</Breadcrumbs>,
)

await user.click(screen.getByRole('button', {name: /more breadcrumb items/i}))

const updatedMenu = screen.getByRole('button', {name: /more breadcrumb items/i}).closest('details') as HTMLElement
expect(within(updatedMenu).getByRole('link', {name: 'New Home'})).toBeInTheDocument()
expect(within(updatedMenu).queryByRole('link', {name: 'Old Home'})).not.toBeInTheDocument()
})

it('show root in menu', () => {
expect(() => {
renderWithTheme(
Expand Down