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

image-palette-core

v0.2.2

Published

Create ARIA-compliant color themes based on any image.

Downloads

1,490

Readme

image-palette-core

The core logic for parsing a palette from image data. You can use this if you want an imperative API for generating a palette. If you want to use it with React you can use react-image-palette

Install

npm install --save image-palette-core

Usage

The main export of the package is a getImagePalette function which takes an image and returns an accessible color palette representing the most dominant colors in the image.

import getImagePalette from 'image-palette-core'

const img = new Image();
img.src = 'foo.jpg';
img.onload = function() {
  // The image *must* be loaded before calling `getImagePalette`
  const palette = getImagePalette(img);
}

⚠️ Keep in mind that the image will be loaded into a canvas and parsed as data, so you should only use images from trusted origins.

The Palette

The parsed palette will have the following shape:

type Palette = {
  backgroundColor: String,
  color: String,
  alternativeColor: String
}
  • backgroundColor will be the most dominant color in the image.
  • color will be the color that looks the best overlayed over backgroundColor.
  • alternativeColor will be the second best color. If there are only two colors parsed, it will default to color.

Both alternativeColor and color are guaranteed to meet the minimum contrast ratio requirements when overlayed with backgroundColor, but overlaying color on alternativeColor (or vice-versa) is a bad idea as they will often have very similar contrast levels.