Skip to content

Inaccessible labels for SVGs in typedoc-generated website #2832

Closed
@phoneticallySAARTHaK

Description

@phoneticallySAARTHaK

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueEasier issue for first time contributorshelp wantedContributions are especially encouraged

    Type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions