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

a11y-contrast-color

v1.1.0

Published

A utility library for calculating luminance, contrast ratio, and appropriate contrast colors to ensure web accessibility.

Downloads

15,660

Readme

🎨 a11y-contrast-color 🎨

version downloads Website Demo Github Repository

a11y-contrast-color is a utility library for calculating luminance, contrast ratio, and recommending appropriate contrast colors to ensure accessibility compliance in web applications.

It helps developers easily determine whether text and background color combinations meet the Web Content Accessibility Guidelines(WCAG) standards by providing functions to recommend contrast colors that can improve readability and accessibility.

Installation

npm install a11y-contrast-color

Or

yarn add a11y-contrast-color

Usage

getLuminance

Calculates the luminance of a color.

Parameters

  • color: RGB (required): An array of three numbers representing the RGB values(value in the range of [0,255]) of the color.

Returns

  • number: The calculated luminance value.
import { getLuminance } from 'a11y-contrast-color';

const luminance = getLuminance([255, 0, 0]);
console.log(luminance); // Output: 0.2126

getContrastRatio

Calculates the contrast ratio between two colors.

Parameters

  • color1: RGB (required): The first color value in RGB format.
  • color2: RGB (required): The second color value in RGB format.

Returns

  • number: The contrast ratio between the two luminance values.
import { getContrastRatio } from 'a11y-contrast-color';

const color1 = [128, 128, 128];
const color2 = [255, 255, 255];
const contrastRatio = getContrastRatio(color1, color2);
console.log(contrastRatio); // Output: 3.949439...

getContrastColor

Determines the appropriate contrast color (black or white) for a given background color to ensure readability.

Parameters

  • color: RGB (required): An array of three numbers representing the RGB values of the background color.
  • luminance: number (required): The target luminance ratio to be achieved or exceeded.

Returns

  • RGB | null: An array representing the RGB values of the contrast color, or null if no suitable color is found.
import { getContrastColor } from 'a11y-contrast-color';

const contrastColor = getContrastColor([255, 0, 0], 4.5);
console.log(contrastColor); // Output: [R, G, B] || null depending on the contrast requirement

All projects are under the MIT license. Please refer to the LICENSE file for more information.