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

contrast-color

v1.0.1

Published

Determines the best contrast color to use. Give it a background color and it returns a foreground color (black or white by default but customizable).

Downloads

27,585

Readme

contrast-color NPM version Build Status Dependency Status Coverage percentage

Determines the best contrast color to use. Give it a background color and it returns a foreground color (black or white by default but customizable).

FYI

Demo (try it for yourself)

Installation

$ npm install contrast-color

Usage

// Use via class instance
const ContrastColor = require('contrast-color');
const cc = new ContrastColor({
  bgColor: "navy",
  fgDarkColor: "navy",
  fgLightColor: "water",
  customNamedColors: {
    water: "#00D0FF",
  },
});

const defaultFgColor = cc.contrastColor();
const hasAquaBgColor = cc.contrastColor({ bgColor: "aqua" });

/* Results
{
  defaultFgColor: '#00D0FF', // water
  hasAquaBgColor: '#000080'  // navy
}
*/

// OR ...

// Use via static method
const { contrastColor } = require('contrast-color');

const hasRedBg = contrastColor({ bgColor: '#f00' });
const hasRedBgWithBlackFg = contrastColor({ bgColor: '#f00', threshold: 76 });
const hasYellowBg = contrastColor({ bgColor: 'yellow' });
const hasWhiteBgWithGreenFg = contrastColor({ fgDarkColor: '#008000' });
const hasBlackBgWithLimeFg = contrastColor({ bgColor: '#000000', fgLightColor: 'lime' });
const hasKitchenSink = contrastColor({ 
  bgColor: '#808080', 
  fgDarkColor: 'dirty', 
  fgLightColor: 'clean', 
  threshold: 129, 
  customNamedColors: { 
    dirty: '#f90', 
    clean: '#ff99ff' 
  } 
});

/* Results:
{
  hasRedBg: '#FFFFFF',              // white
  hasRedBgWithBlackFg: '#000000',   // black
  hasYellowBg: '#000000',           // black
  hasWhiteBgWithGreenFg: '#008000', // green
  hasBlackBgWithLimeFg: '#00FF00',  // lime
  hasKitchenSink: '#ff99ff'         // clean
}
*/

API

ContrastColor(defaults)

  • defaults

    Optional: Object with parameters to use.

    • bgColor
      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #FFFFFF
    • fgDarkColor

      Is returned if bgColor is determined to be light

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #000000
    • fgLightColor

      Is returned if bgColor is determined to be dark

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #FFFFFF
    • defaultColor

      Is returned if bgColor is determined to be invalid

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #000000
    • threshold
      • Optional : Number (0-255) used to adjust variance
      • Default : 128
    • customNamedColors
      • Optional : Object used to override or add named colors (e.g. { blue: "#0074D9" })

.contrastColor(options)

  • options

    Requrired: Object with parameters to use.

    • bgColor
      • Required : String hex or named (e.g.#ff0000, red)
    • fgDarkColor

      Is returned if bgColor is determined to be light

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #000000
    • fgLightColor

      Is returned if bgColor is determined to be dark

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #FFFFFF
    • defaultColor

      Is returned if bgColor is determined to be invalid

      • Optional : String hex or named (e.g.#ff0000, red)
      • Default : #000000
    • threshold
      • Optional : Number (0-255) used to adjust variance
      • Default : 128
    • customNamedColors
      • Optional : Object used to override or add named colors (e.g. { blue: "#0074D9" })

License

ISC © Buster Collings