omgovich / colord

👑 A tiny yet powerful tool for high-performance color manipulations and conversions
https://colord.omgovich.ru
MIT License
1.67k stars 50 forks source link

Return A11y score as text? #107

Open jameschetwood opened 1 year ago

jameschetwood commented 1 year ago

It would be great if this library could return the colour contrast score in text eg how this other library works:

https://github.com/tmcw/wcag-contrast#score score(10); // = 'AAA'

Currently you would need to use the isReadable function to return booleans and manually workout the text score, right?

const aaa = colord("#e60000").isReadable("#ffff47", { level: "AAA" }); // false
const aaaLarge = colord("#e60000").isReadable("#ffff47", { level: "AAA", size: "large" }); // true 

if(aaa) return 'AAA'
if(aaaLarge) return 'AAA large'
return 'FAIL'