Color combination contrast tester
npm install colorable
Pass an array of color strings or an object with color strings as values.
var colorable = require('colorable');
var colors = {
red: 'red',
green: 'green',
blue: 'blue'
};
var options = {
compact: true,
threshold: 4.5
};
var result = colorable(colors, options);Returns an array of colors with combinations for all other colors and their WCAG contrast values.
[
{
"hex": "#FF0000",
"name": "red",
"combinations": [
{
"hex": "#008000",
"name": "green",
"contrast": 1.28483997166146,
"accessibility": {
"aa": false,
"aaLarge": false,
"aaa": false,
"aaaLarge": false
}
},
{
"hex": "#0000FF",
"name": "blue",
"contrast": 2.148936170212766,
"accessibility": {
"aa": false,
"aaLarge": false,
"aaa": false,
"aaaLarge": false
}
}
]
},
...
]Each key is a boolean value indicating if the color contrast meets the following criteria:
aa - contrast is a minimum of 4.5 (for normal sized text)aaLarge - contrast is a minimum of 3 (for bold text or text larger than 24px)aaa - contrast is a minimum of 7 aaaLarge - contrast is a minimum of 4.5 compactType: Boolean (default: false)
If set to true, the result will only include hex value color strings, a name for each color (if an object is passed to the function), contrast, and accessibility values.
When set to false, the result also includes the entire color object for each color.
thresholdType: Number (default: 0)
When set, the colorable function only returns combinations that have a contrast above this value. This is useful for only seeing combinations that pass a minimum contrast level.