npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@opendevtools/wcag-color

v1.2.1

Published

Color constrast helpers to achieve the WCAG 2.0 standard

Downloads

2,326

Readme

WCAG Color

npm (scoped)

According to the WHO an estimated 1.3 billion people live with some form of visual impairment. This includes people who are legally blind and people with less than 20/20 vision.

This library helps you achieve the accessibility standards for color contrast outlined in the WCAG 2.0 specification.

Installation

npm install @opendevtools/wcag-color

API

Ratio

ratio takes two colors, a foreground color, and background color, and returns a contrast ratio. ratio accepts most color formats:

  • HEX - normal (#0088ff), shorthand (#08f) and without hash (08f)
  • RGB - rgb(255, 255, 255)
  • HSL - hsl(210, 100%, 40%)
ratio(foreground: string, background: string) => number

Example

import { ratio } from "wcag-color";

ratio("hsl(210, 100%, 40%)", "#ffffff"); // 5.57

Score

score takes two colors and returns a score value. Read more below.

score(foreground: string, background: string) => 'Fail' | 'AA Large' | 'AA' | 'AAA'

Example

import { score } from "wcag-color";

score("hsl(210, 100%, 40%)", "#ffffff"); // AA

Score from ratio

scoreFromRatio takes a ratio and returns a score value.

scoreFromRatio(ratio: number) => 'Fail' | 'AA Large' | 'AA' | 'AAA'

Example

import { scoreFromRatio } from "wcag-color";

scoreFromRatio(7.5); // AAA

Best color out of two

best takes two colors and a background color and returns the color which is best suited, from a contrast perspective, for that background color.

best(firstColor: string, secondColor: string, background: string) => string

Example

import { best } from "wcag-color";

best("#ffffff", "#000000", "#ffffff"); // #000000

Score and ratio

  • Fail - Your text has a contrast ratio of less than 3.0
  • AA Large - Least amount of contrast for font size 18px and larger. The ratio is above 3.0.
  • AA - What you should aim for with text sizes below 18px. The ratio is at least 4.5.
  • AAA - Enhanced contrast with a ratio of at least 7.0. Valuable for texts that will be read for a longer period of time.