ActionList: Add aria-describedby back to ActionList.Item
#6146
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 59a6b23 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
|
👋 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
bot
added
the
integration-tests: recommended
size-limit report 📦
|
There was a problem hiding this comment.
Pull Request Overview
This PR restores the aria-describedby attribute on ActionList.Item when a description is present and the CSS modules feature flag is enabled.
- Adjusts the
aria-describedbylogic inItem.tsxto include the description under the CSS modules flag - Adds two new tests in
Item.test.tsxto verifyaria-describedbyis applied for both default andlistboxroles - Updates the changeset to bump a patch release with these changes
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/react/src/ActionList/Item.tsx | Expanded the aria-describedby array to include the description ID when CSS modules flag is enabled |
| packages/react/src/ActionList/Item.test.tsx | Added tests verifying aria-describedby is present on items with descriptions under the feature flag |
| .changeset/hip-snakes-pay.md | Bumped @primer/react patch version and summarized the PR changes |
Comments suppressed due to low confidence (2)
packages/react/src/ActionList/Item.test.tsx:439
- Consider adding a test for the inline description variant (
<ActionList.Description variant="inline">) under the CSS modules flag to ensurearia-describedbyis applied in that scenario as well.
it('should add `aria-describedby` to items with a description', () => {
packages/react/src/ActionList/Item.tsx:344
- The condition references
slots.description, which isn't a defined slot (the inline description slot is namedslots.inlineDescription). As written, descriptions under the CSS modules flag won’t be included correctly. Update this to checkslots.inlineDescription(or consolidate the block/inline checks) so the intended descriptions are always added.
slots.blockDescription ? blockDescriptionId : enabled && slots.description ? blockDescriptionId : undefined,
jonrohan
approved these changes
May 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes https://github.com/github/primer/issues/5256
Adds
aria-describedbyback toActionList.Itemwhen CSS modules flag is enabled.Changelog
Changed
aria-describedbyis added toActionList.Itemwhen a description is present and the CSS modules flag is enabledRollout strategy
Testing & Reviewing
Merge checklist