Skip to content

ActionList: restore aria-describedby for inline descriptions #7706

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

Open
liuliu-dev wants to merge 3 commits into
base: main
Choose a base branch
from
+44 −3
Open

ActionList: restore aria-describedby for inline descriptions #7706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca0b06c
aria-describedby for inline description
liuliu-dev Mar 26, 2026
95b55f5
test
liuliu-dev Mar 26, 2026
730869c
changeset
liuliu-dev Mar 26, 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/tough-ears-drive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

ActionList.Item: fix inline descriptions being referenced via `aria-labelledby` instead of `aria-describedby`
36 changes: 36 additions & 0 deletions packages/react/src/ActionList/ActionList.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,42 @@ describe('ActionList', () => {
expect(descriptions[2]).not.toHaveAttribute('title')
})

it('references inline description via aria-describedby', () => {
const {container} = HTMLRender(
<ActionList role="listbox" selectionVariant="single" aria-label="List">
<ActionList.Item role="option">
Item label
<ActionList.Description>Inline description</ActionList.Description>
</ActionList.Item>
</ActionList>,
)

const item = container.querySelector('[role="option"]')!
const descriptionEl = container.querySelector('[data-component="ActionList.Description"]')!
const descriptionId = descriptionEl.getAttribute('id')!

expect(item.getAttribute('aria-describedby')).toContain(descriptionId)
expect(item.getAttribute('aria-labelledby')).not.toContain(descriptionId)
})

it('references block description via aria-describedby', () => {
const {container} = HTMLRender(
<ActionList role="listbox" selectionVariant="single" aria-label="List">
<ActionList.Item role="option">
Item label
<ActionList.Description variant="block">Block description</ActionList.Description>
</ActionList.Item>
</ActionList>,
)

const item = container.querySelector('[role="option"]')!
const descriptionEl = container.querySelector('[data-component="ActionList.Description"]')!
const descriptionId = descriptionEl.getAttribute('id')!

expect(item.getAttribute('aria-describedby')).toContain(descriptionId)
expect(item.getAttribute('aria-labelledby')).not.toContain(descriptionId)
})

it('should support size prop on LinkItem', () => {
const {container} = HTMLRender(
<ActionList>
Expand Down
6 changes: 3 additions & 3 deletions packages/react/src/ActionList/Item.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,16 +232,16 @@ const UnwrappedItem = <As extends React.ElementType = 'li'>(
const ariaLabelledBy = React.useMemo(() => {
const parts = [labelId]
if (hasTrailingVisualSlot) parts.push(trailingVisualId)
if (hasDescriptionSlot && descriptionVariant === 'inline') parts.push(inlineDescriptionId)
return parts.join(' ')
}, [labelId, hasTrailingVisualSlot, trailingVisualId, hasDescriptionSlot, descriptionVariant, inlineDescriptionId])
}, [labelId, hasTrailingVisualSlot, trailingVisualId])

const ariaDescribedBy = React.useMemo(() => {
const parts: string[] = []
if (hasDescriptionSlot && descriptionVariant === 'block') parts.push(blockDescriptionId)
if (hasDescriptionSlot && descriptionVariant === 'inline') parts.push(inlineDescriptionId)
if (inactiveWarningId) parts.push(inactiveWarningId)
return parts.length > 0 ? parts.join(' ') : undefined
}, [hasDescriptionSlot, descriptionVariant, blockDescriptionId, inactiveWarningId])
}, [hasDescriptionSlot, descriptionVariant, blockDescriptionId, inlineDescriptionId, inactiveWarningId])

const menuItemProps = React.useMemo(
() => ({
Expand Down
Loading