openlibhums / openlibhums/janeway
Improve colour contrast A11y by defining colour pairings for text
Open
@joemull is already working on this.
Since Apr 18, 2024.
a11y
t-shirt epic
- Dominant language
- Python
- Stars
- 238
- Forks
- 97
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 8
Description
Currently theme colours are given as primary, secondary and tertiary colours.
This means that the contrast between text colour and background colour are not necessarily considered when creating the theme.
Proposal:
- Instead of thinking of text in terms of the colour of the text, we should move to considering text as a colour pairing of colour of text and its background (what colour ink to use on what colour of paper, rather than colour of ink alone).
- Theme colours should be specified in pairs, and each pairing could be checked for contrast against the WCAG standards when chosen.
Practical considerations:
- should text colour pairs be defined explicitly as settings?
- shall we have Janeway report the contrast ratio for that pairing whenever it is updated, and warn if it is below standard?
- should all theme colours be defined as pairs, such that the appropriate colour for any text against that background is always known, or should text colour pairings be a subsection of theme colours?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.