color-kitnext

@pbroom/color-kitContrast

meetsAAA

Returns whether two colors meet WCAG 2.1 level AAA: a contrast ratio of at least 7:1, or 4.5:1 when largeText is true.

functionimport { meetsAAA } from '@pbroom/color-kit';metrics.ts:363
function meetsAAA(
  color1: Color,
  color2: Color,
  largeText?: boolean,
  options?: ContrastOptions,
): boolean;

Parameters

color1Color
First color (order does not matter).
color2Color
Second color.
largeText?booleandefault false
Apply the large-text threshold (4.5:1).
options?ContrastOptions
Display gamut and channel precision, as for contrastRatio.

Returns

boolean

Throws

  • When options.gamut is not 'srgb' or 'display-p3'.

Example

TypeScript
import { meetsAAA, parse } from '@pbroom/color-kit';

meetsAAA(parse('#595959'), parse('#fff')); // → true
meetsAAA(parse('#666'), parse('#fff')); // → false
meetsAAA(parse('#666'), parse('#fff'), true); // → true

See also

meetsAA