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-pal

v1.2.2

Published

Retrieve human perceivable palette of colors from images leveraging color quantization

Downloads

1,008

Readme

Intro

Retrieve human perceivable palette of colors from images leveraging color quantization. What sets Image-Pal apart from other image-based color palette generators is that you can easily plugin other color spaces (or variations of existing) to achieve the desired palette.

NPM

Usage

Built-in support for RGB and HSLuv color spaces. Or easily plugin other color spaces.

  const getColors = require('image-pal/lib/hsluv');
  // OR if you want the non-human-perceptual version based on pure RGB
  // const getColors = require('image-pal/lib/rgb');
  
  const colors = getColors(myImageBytes, options);
  colors.forEach(color => {
    console.log(color.rgb); // [ 100, 100, 100 ]
    console.log(color.alpha); // 255
    console.log(color.hex); // #abc123
    // below props only available if using `hsluv` version
    console.log(color.hsluv); // [ 1, 50, 100 ]
  });

Helpers

Depending how you intend to access the images, there are a few high-performance recommendations:

  • image-pal-canvas - A browser based implementation that leverages Image and Canvas for fast palette generation.
  • image-pal-sharp - A Node.js based implementation that leverages Sharp and libvips for fast palette generation.
  • image-steam - An Image API with built-in support, already optimized for you.

By leveraging browser and server implementations you can provide consistent (though NOT identical) palette generation across your stack. Generated palettes will still vary slightly as the image resize operations vary in algorithm across browsers and server implementations. If consistency is critical you might consider one of the server-only solutions.

Options

| Name | Type | Default | Desc | | --- | --- | --- | --- | | hasAlpha | Boolean | required | If input has alpha it'll read 4-byte colors instead of the default 3 | | maxColors | Number | 10 | Maximum size of colors to return. Only one is garuanteed | | minDensity | Number | 0.005 | Minimum cell density (0.5%) required to be considered a valid palette color | | cubicCells | Number | 4 | Number of cells per dimension in 3d space. Higher number of cells increases cpu time but can be useful if you want to return a large palette (greater than 10 maxColors). Only (3^3=27) or (4^3=64) supported | | mean | Boolean | true | By default the mean color will be computed which is generally desired. If set to false the median color will be selected. | | order | String | distance | Order of the returned color palette. By default will be ordered based on the distance between colors. Or density if cell density is desired. |

Logos

In the case you're working with a logo where brand is everything, disabling mean to select the median color will avoid tampering with brand colors.

{ mean: false }

Performance

While this library is light weight, if it's used with very large images it can still take a considerable amount of time. See Helpers for high-performance production usage.

Custom Color Spaces

It's quite simple to leverage a different color space or a variation of the provided color spaces (RGB or HSLuv).

  const getColors = require('image-pal/lib/rgb'); // extend rgb generator
  
  function rgbColorPlacer(c) {
    // instead, I could convert RGB to an alternate color space, OR change the placement logic within the RGB spectrum
    return [
      c.rgb[0] / 256, // x=0-1
      c.rgb[1] / 256, // y=0-1
      c.rgb[2] / 256 // z=0-1
    ];
  }

  const colors = getColors(myImageBytes, { colorPlacer: rgbColorPlacer });
  // do something with colors...