UNPKG

@jeact/contrast-color

Version:

Simple function to get the contrast color for a text over some color

github.com/JebBarbas/jeact-contrast-text

JebBarbas/jeact-contrast-text

14 lines (13 loc) • 719 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
import type { Color } from './types'; /** * Calculates the contrast ratio between 2 colors * Formula (Ratio): https://www.w3.org/TR/WCAG20/#contrast-ratiodef * Contrast Conditions: https://www.w3.org/TR/WCAG20/#visual-audio-contrast-contrast (normal) * Contrast Conditions: https://www.w3.org/TR/WCAG20/#visual-audio-contrast7 (bold) * @param bgColor A string representation of a color * @param fgColor A string representation of a color * @param echo Set to true if you are testing, otherwise, only set to true when yo want lo log the results * @returns The contrast ratio between 2 colors */ declare const contrastRatio: (bgColor: Color, fgColor: Color) => number; export default contrastRatio;