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.

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

Inaccessible labels for SVGs in typedoc-generated website #2832

Open
phoneticallySAARTHaK opened this issue Jan 20, 2025 · 3 comments
Open
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@phoneticallySAARTHaK
Copy link

Search terms

accessiblilty, screen readers, narrator, aria, graphic

Expected Behavior

Typedoc should provide accessible labels for all relevant icons that convey information to user.

For example, in search, the options should be read aloud clearly like "Module alias", or "type Foo/f1".

Actual Behavior

For example, in search, the icons are simply read as the letter it represents, not the semantic meaning.

Narrator would read [M] alias as "malias".

Steps to reproduce the bug

This isn't related to a particular setup, since there's no semantic information, any screen reader won't be able to announce the results properly. In my case, I used narrator.

Environment

  • Typedoc version: 0.27.6
  • screen reader: Narrator
  • OS: windows 10
@phoneticallySAARTHaK phoneticallySAARTHaK added the bug Functionality does not match expectation label Jan 20, 2025
@phoneticallySAARTHaK
Copy link
Author

This can be done by adding aria-label attribute, and changing the role attribute, But it'll need to be tested properly

@Gerrit0 Gerrit0 added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors labels Jan 21, 2025
@sanwalsulehri
Copy link

i can do this easily

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Feb 2, 2025

Go for it!

@Gerrit0 Gerrit0 removed the bug Functionality does not match expectation label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

No branches or pull requests

3 participants