Skip to content

[Documentation]: Sidebar accessibility issues #349

Description

@WHeirstrate

Is your feature request related to a problem? Please describe.
We currently use the default generated sidebar by NgDoc. This is the NgDocSidebarComponent and works as it should, but it is not accessible. Every expandable item is a div with a click listener.

The location where the div gets rendered: NgDoc permalink

Describe the solution you'd like
The navbar should be replaced by a more accessible one. Sadly, this appears to entail that the entire navbar should be replaced by a custom component.

Describe alternatives you've considered

  • In the app-root, get the contentchildren based on a tag exclusive to the div elemets and add a tablindex, role and aria-label to improve accessibility. This requires more excessive re-rendering of the sidebar component.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions