storybookjs/storybook

[Bug]: Accessibility checker incorrectly identifies `aria-description` as an invalid attribute

Closed

#22,337 opened on May 1, 2023

View on GitHubContributor guide
 (3 comments) (0 reactions) (0 assignees)TypeScript (10,058 forks)batch import
addon: a11ybughelp wanted

Repository metrics

Stars
 (89,909 stars)
PR merge metrics
 (Avg merge 7d 22h) (184 merged PRs in 30d)

Description

Describe the bug

The accessibility checker doesn't recognize the aria-description attribute.

https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-description

I have verified with NVDA that aria-description works.

To Reproduce

Add aria-description attribute to any HTML element.

image

System

No response

Additional context

No response

Contributor guide

Research direction
The bug is that the accessibility checker in Storybook's addon a11y does not recognize the valid ARIA attribute `aria description`. To fix, locate the file that defines the list of valid ARIA attributes (likely in the addon a11y package, e.g., `addons/a11y/src/constants.ts` or similar). Add `aria description` to that list. Verify using the MDN documentation linked in the issue. No other changes are needed; this is a localized addition.
Tech stack
typescriptreact
Domain
accessibilityfrontend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Familiarity with ARIA attributesKnowledge of Storybook's addon a11y codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80