Skip to content
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

Jump to bottom

TreeView: Add custom aria label to TreeView.Item #4617

Merged
merged 3 commits into from
May 29, 2024
Merged

TreeView: Add custom aria label to TreeView.Item #4617

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e2c82d
Add custom aria label to TreeView.Item
JelloBagel May 21, 2024
a437190
Add changelog
JelloBagel May 21, 2024
32dc53f
Update hungry-rockets-smell.md
JelloBagel May 28, 2024
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/hungry-rockets-smell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': minor
---

Add custom aria label to TreeView.Item
JelloBagel marked this conversation as resolved.
Show resolved Hide resolved
24 changes: 24 additions & 0 deletions packages/react/src/TreeView/TreeView.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,30 @@ describe('Markup', () => {
expect(items).toHaveLength(3)
})

it('uses treeitem aria label', () => {
const {queryAllByRole} = renderWithTheme(
<>
<TreeView>
<TreeView.Item id="item-1" aria-label="Test tree item 1">
Item 1
</TreeView.Item>
<TreeView.Item id="item-2" aria-labelledby="test-description">
Item 2
</TreeView.Item>
<TreeView.Item id="item-2">Item 3</TreeView.Item>
</TreeView>
<span id="test-description">Tree item 2 description</span>
</>,
)

const items = queryAllByRole('treeitem')
expect(items).toHaveLength(3)
expect(items[0]).toHaveAccessibleName('Test tree item 1')
expect(items[1]).toHaveAccessibleName('Tree item 2 description')
expect(items[2]).toHaveAttribute('aria-labelledby')
expect(items[2]).toHaveAccessibleName('Item 3')
})

it('hides subtrees by default', () => {
const {queryByRole} = renderWithTheme(
<TreeView aria-label="Test tree">
Expand Down
7 changes: 6 additions & 1 deletion packages/react/src/TreeView/TreeView.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,8 @@ Root.displayName = 'TreeView'
// TreeView.Item

export type TreeViewItemProps = {
'aria-label'?: React.AriaAttributes['aria-label']
'aria-labelledby'?: React.AriaAttributes['aria-labelledby']
id: string
children: React.ReactNode
containIntrinsicSize?: string
Expand All @@ -375,6 +377,8 @@ const Item = React.forwardRef<HTMLElement, TreeViewItemProps>(
onSelect,
children,
className,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledby,
},
ref,
) => {
Expand Down Expand Up @@ -472,7 +476,8 @@ const Item = React.forwardRef<HTMLElement, TreeViewItemProps>(
tabIndex={0}
id={itemId}
role="treeitem"
aria-labelledby={labelId}
aria-label={ariaLabel}
aria-labelledby={ariaLabel ? undefined : ariaLabelledby || labelId}
aria-describedby={`${leadingVisualId} ${trailingVisualId}`}
aria-level={level}
aria-expanded={isSubTreeEmpty ? undefined : isExpanded}
Expand Down
Loading