Skip to main content

Contrast & Accessibility Methods

contrastRatio()​

Signature​

contrastRatio(other: ColorType | CSSColor): number

Parameters​

  • other: The color to compare against.

Return Type​

number – The WCAG contrast ratio (rounded to 2 decimal places).

Notes​

  • 1 = No contrast.
  • 21 = Maximum contrast (black vs. white).

Example​

const black = new Color("#000000");
const white = new Color("#ffffff");
console.log(black.contrastRatio(white)); // 21.00

getWCAGRating()​

Signature​

getWCAGRating(other: ColorType | CSSColor): 'Fail' | 'AA' | 'AAA'

Parameters​

  • other: The color to test against.

Return Type​

  • "Fail" (Ratio < 4.5)
  • "AA" (Ratio ≥ 4.5)
  • "AAA" (Ratio ≥ 7)

Example​

const text = new Color("#333333");
const background = new Color("#f0f0f0");
console.log(background.getWCAGRating(text)); // "AA"

isLightColor()​

Signature​

isLightColor(): boolean

Return Type​

boolean – true if the color is light (perceived brightness > 50%).

Example​

new Color("#ffffff").isLightColor(); // true
new Color("#000000").isLightColor(); // false