Skip to content

Apply correct markup to selected breadcrumb items #833

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

Merged
merged 6 commits into from
Nov 28, 2024
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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/sharp-pets-thank.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react-brand': patch
---

`selected` breadcrumb items now use non-interactive elements for improved keyboard navigation and correct semantics.
12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/react/src/Breadcrumbs/Breadcrumbs.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@
.Breadcrumbs__link--selected {
color: var(--brand-color-text-default);
pointer-events: none;
font-weight: inherit;
letter-spacing: inherit;
}
.Breadcrumbs--default .Breadcrumbs__link--selected {
color: var(--brand-color-text-muted);
Expand Down
41 changes: 31 additions & 10 deletions packages/react/src/Breadcrumbs/Breadcrumbs.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ describe('Breadcrumbs', () => {
<Breadcrumbs>
<Breadcrumbs.Item href="/">Resources</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot">GitHub Copilot</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot/chat" selected>
Chat
</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot/chat">Chat</Breadcrumbs.Item>
</Breadcrumbs>,
)

Expand All @@ -54,8 +52,34 @@ describe('Breadcrumbs', () => {
const item3 = breadcrumbLinkEls[2]
expect(item3.textContent).toBe('Chat')
expect(item3.getAttribute('href')).toBe('/copilot/chat')
expect(item3.classList).toContain('Breadcrumbs__link--selected')
})

it('renders selected items correctly into the document', () => {
const {getByText, getAllByRole} = render(
<Breadcrumbs>
<Breadcrumbs.Item href="/">Resources</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot">GitHub Copilot</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot/chat" selected>
Chat
</Breadcrumbs.Item>
</Breadcrumbs>,
)

const breadcrumbLinkEls = getAllByRole('link')
expect(breadcrumbLinkEls).toHaveLength(2)

const item1 = breadcrumbLinkEls[0]
expect(item1.textContent).toBe('Resources')
expect(item1.getAttribute('href')).toBe('/')

const item2 = breadcrumbLinkEls[1]
expect(item2.textContent).toBe('GitHub Copilot')
expect(item2.getAttribute('href')).toBe('/copilot')

const item3 = getByText('Chat')
expect(item3).toHaveAttribute('aria-current', 'page')
expect(item3.tagName).toBe('span'.toUpperCase())
expect(item3.classList).toContain('Breadcrumbs__link--selected')
})

it('renders accent variant correctly into the document', () => {
Expand All @@ -74,8 +98,8 @@ describe('Breadcrumbs', () => {
})

it('accepts a custom aria-current value to override the default', () => {
const {getByRole} = render(
<Breadcrumbs variant="accent">
const {getByText} = render(
<Breadcrumbs>
<Breadcrumbs.Item href="/">Resources</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot">GitHub Copilot</Breadcrumbs.Item>
<Breadcrumbs.Item href="/copilot/chat" selected aria-current="location">
Expand All @@ -84,11 +108,8 @@ describe('Breadcrumbs', () => {
</Breadcrumbs>,
)

const breadcrumbsEl = getByRole('navigation')
expect(breadcrumbsEl).toHaveClass('Breadcrumbs--accent')
const item3 = getByText('Chat')

const breadcrumbLinkEls = breadcrumbsEl.querySelectorAll('a')
const item3 = breadcrumbLinkEls[2]
expect(item3).toHaveAttribute('aria-current', 'location')
})
})
25 changes: 16 additions & 9 deletions packages/react/src/Breadcrumbs/Breadcrumbs.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import '@primer/brand-primitives/lib/design-tokens/css/tokens/functional/compone
/** * Main Stylesheet (as a CSS Module) */
import styles from './Breadcrumbs.module.css'
import {InlineLink} from '../InlineLink'
import {Text} from '../Text'

export const BreadcrumbVariants = ['default', 'accent'] as const

Expand Down Expand Up @@ -46,15 +47,21 @@ const _Item = forwardRef<HTMLAnchorElement, ItemProps>(
({'aria-current': ariaCurrent, className, children, href, selected, ...rest}, ref) => {
return (
<li className={styles.Breadcrumbs__item}>
<InlineLink
href={href}
ref={ref}
className={clsx(styles.Breadcrumbs__link, selected && styles['Breadcrumbs__link--selected'], className)}
aria-current={ariaCurrent ? ariaCurrent : selected ? 'page' : undefined}
{...rest}
>
{children}
</InlineLink>
{selected ? (
<Text
size="100"
variant="muted"
className={clsx(styles.Breadcrumbs__link, styles['Breadcrumbs__link--selected'], className)}
aria-current={ariaCurrent ? ariaCurrent : 'page'}
{...rest}
>
{children}
</Text>
) : (
<InlineLink href={href} ref={ref} className={clsx(styles.Breadcrumbs__link, className)} {...rest}>
{children}
</InlineLink>
)}
</li>
)
},
Expand Down
Loading