import {ContrastChecker} from 'color-contrast-calc/lib/contrast-checker.js'

public class | source

ContrastChecker

Collection of functions that check properties of given colors

Static Method Summary

Static Public Methods
public static	contrastRatio(foreground: string \| Array<number, number, number>, background: string \| Array<number, number, number>): number Calculate the contrast ratio of given colors
public static	isLightColor(color: string \| Array<number, number, number>): boolean Check if the contrast ratio of a given color against black is higher than against white.
public static	ratioToLevel(ratio: number): string Rate a given contrast ratio according to the WCAG 2.0 criteria
public static	relativeLuminance(rgb: string \| Array<number, number, number>): number Calculate the relative luminance of a RGB color given as a string or an array of numbers

Calculate the contrast ratio of given colors

Name	Type	Attribute	Description
foreground	string \| Array<number, number, number>		RGB value represented as a string (hex code) or an array of numbers
background	string \| Array<number, number, number>		RGB value represented as a string (hex code) or an array of numbers

Contrast ratio

Check if the contrast ratio of a given color against black is higher than against white.

Name	Type	Attribute	Description
color	string \| Array<number, number, number>		RGB value represented as a string (hex code) or an array of numbers

true if the contrast ratio against white is qual to or less than the ratio against black

Rate a given contrast ratio according to the WCAG 2.0 criteria

Name	Type	Attribute	Description
ratio	number		Contrast ratio

A, AA or AAA if the contrast ratio meets the criteria of WCAG 2.0, otherwise "-"

Calculate the relative luminance of a RGB color given as a string or an array of numbers

Name	Type	Attribute	Description
rgb	string \| Array<number, number, number>		RGB value represented as a string (hex code) or an array of numbers

Relative luminance