Skip to content

Grabs the dominant color or a representative color palette from an image with node. Uses javascript and jimp.

License

Notifications You must be signed in to change notification settings

jeanmatthieud/color-thief-jimp

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Color Thief with Jimp for NodeJs

A script for grabbing the color palette from an image. Uses Javascript and the Jimp to make it happen. This fork does NOT use canvas, and is can only used with NodeJs.

Install NodeJs

Install the module via npm

npm install color-thief-jimp --save

And use it:

var ColorThief = require('color-thief-jimp');

How to use

Get the dominant color from an image

var ColorThief = require('color-thief-jimp');
var Jimp = require('jimp');

Jimp.read(imageFilepathOrUrl, (err, sourceImage) => {
  if (err) {
    console.error(err);
    return;
  }

  // getColor(sourceImage[, quality])
  var dominantColor = ColorThief.getColor(sourceImage);
  // dominantColor = [intRed, intGreen, intBlue]
});

Build a color palette from an image

In this example, we build an 8 color palette.

var ColorThief = require('color-thief-jimp');
var Jimp = require('jimp');

Jimp.read(imageFilepathOrUrl, (err, sourceImage) => {
  if (err) {
    console.error(err);
    return;
  }

  // getPalette(sourceImage[, colorCount, quality])
  var palette = ColorThief.getPalette(sourceImage, 8);
  // palette = [ [intRed, intGreen, intBlue], [intRed, intGreen, intBlue], ... ]
});

Changelog

2016-02-26

First release.

Credits

Source code based on color-thief (MIT license) by Lokesh Dhakar lokeshdhakar.com

About

Grabs the dominant color or a representative color palette from an image with node. Uses javascript and jimp.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%