Nine Pedestrians Mesmerized
Have ideas to improve npm?Join in the discussion! »

color-contrastTypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

color-contrast

npm tests dependencies coverage

Performance-sensitive WCAG contrast ratio calculation.

Note: This project is in early development, and versioning is a little different. Read this for more details.

Why should you care?

There are several projects that give you the contrast ratio, but I was unable to find any that didn't have too many dependencies to be viable for performance-conscious browser use and were also wcag-compliant. This one is both. It's ~5kb gzipped, and supports all color formats supported by css, so no need to run any type of color conversions in or out.

Installation

npm install color-contrast

Usage

This is a very simple module, it only exposes a single export and can be used as such:

import colorContrast from 'color-contrast'
 
colorContrast('#fff', '#000') // => 21
colorContrast('#fff', '#eee') // => 1.1602304710270739

WCAG standards dictate that you want >=4.5 as a ratio for AA compliance and >= 7 for AAA compliance. You should aim for the latter if possible.

License & Contributing

Keywords

none

Install

npm i color-contrast

DownloadsWeekly Downloads

1,215

Version

1.0.0

License

MIT

Unpacked Size

62.9 kB

Total Files

5

Last publish

Collaborators

  • avatar