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

@phbalance/contrast-colour

v0.0.6

Published

Small library for calculating contrasting colours.

Downloads

19

Readme

Finding the highest contrast colour

Utility for determining the highest constrasting colour. Built on color. It is implemented in TypeScript.

Getting Started

Installation

npm install --save @phbalance/contrast-colour # Note the non-American spelling

npm install --save color # This is a peer dependency for contrast-colour. Install if you don't already use it in your project.

Use

import { chooseHighestContrastColour } from "@phbalance/constrast-colour";

...

const contrastColour: string = chooseHighestContrastColour(foregroundColour, foregroundOpacity, backgroundColour)

API

chooseHighestContrastColour was created with itch to have the highest contrast (black or white) text on the blended colour of a surface. It makes the assumption that both of the 2 possible surfaces that can blend can each be represented by a single colour. The method requires 1 parameter for the simple case of no opacity, but supports up to 3 parameters for more complex cases:

  • foregroundColour (required) is the colour of the surface you want to put your text on.
  • foregroundOpacity (optional - default is 1.0) is the opacity of the surface you want to put your text on. You can omit this if the surface you're painting on is not see through at all. Otherwise, you should provide this and the backgroundColour so the effective blended colour can be determined.
  • backgroundColour (optional - default is white) is the colour of the surface behind the main surface that the text will be put on.

The return value is a colour, either white or black, as a 3 byte RGB hex value string.

Reporting Issues

You can report bugs here. Feel free to make suggestions as well.