Function: isAccessible()

function isAccessible(
   foreground, 
   background, 
   level?): boolean;

Returns true if the foreground/background pair meets the given WCAG contrast level ('AA' requires ≥ 4.5, 'AAA' requires ≥ 7).

Parameters

Parameter	Type	Default value
foreground	string	undefined
background	string	undefined
level	"AA" | "AAA"	'AA'

Returns

boolean

Example

isAccessible('#ffffff', '#000000', 'AA') // => true
isAccessible('#cccccc', '#ffffff', 'AA') // => false

Since

1.0.0