Next Planet of Monkeys
Learn how companies like Phone2Action are using npm in their front-end developmentJoin the conversation »

colorthief

2.3.0 • Public • Published

Color Thief

A script for grabbing the color palette from an image. Uses Javascript and the canvas tag to make it happen.

See a Demo | Read more on my blog

How to use

Import

  • /dist/color-thief.js: CommonJS module for use in Node.
  • /dist/color-thief.mjs: ES6 module for use in Browser. For modern browsers as well as Webpack and Rollup.
  • /dist/color-thief.umd.js: UMD module for use in Browser. For simple script tag loading that exposes a global variable or for RequireJS AMD support. color-thief.min.js is a duplicate of this file, kept around to maintain backwards compatibility.

Get the dominant color from an image

const colorThief = new ColorThief();
colorThief.getColor(sourceImage);

Build a color palette from an image

In this example, we build an 8 color palette.

const colorThief = new ColorThief();
colorThief.getPalette(sourceImage, 8);

API

Method Return Description
getColor(image [, quality]) [Number, Number, Number] WIP
getPalette(image [, colorCount, quality] [[Number, Number, Number], ...] WIP

Install

npm i colorthief

DownloadsWeekly Downloads

2,667

Version

2.3.0

License

MIT

Unpacked Size

553 kB

Total Files

40

Last publish

Collaborators

  • avatar