Skip to content

Improve interactive element color contrast on api docs #9075

@1zzowiebeha

Description

@1zzowiebeha

Description

On the api documentation, there are many interactive elements such as the top navbar items, the sidebar to view reference pages, the table of contents to jump to object members on the page, and the mobile sidebar.

At the moment, there is low background color contrast for these elements. This is especially so for the sidebar when in dark mode.

This can be improved by giving such hover-able elements a greater color contrast, and-- when visually suitable-- an underline effect to improve visual accessibility for readers.

I've gone ahead and written the code to accomplish this by overriding a few clean-jsdoc-theme defaults within /build/docs/styles/videojs.css (see pull #9076). I built the api documentation locally and nothing appears to be out of the ordinary.

Reduced test case

https://docs.videojs.com/

Steps to reproduce

  1. Hover over sidebar and table of contents links on light & dark mode
  2. Observe low-contact background changes for sidebar titles, sidebar reference links, and table of contents links

Errors

No response

What version of Video.js are you using?

v8.21.1 (latest)

Video.js plugins used.

No response

What browser(s) including version(s) does this occur with?

all

What OS(es) and version(s) does this occur with?

all

Metadata

Metadata

Assignees

No one assigned

    Labels

    needs: triageThis issue needs to be reviewed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions