mirror of https://github.com/janishutz/color-thief.git synced 2025-11-25 13:54:25 +00:00

Files

Lokesh Dhakar c91f3e808e feat: Add module support with new dist files

- `/dist/color-thief.umd.js`: UMD module. For simple script tag loading that exposes a global variable or for RequireJS AMD support.
- `/dist/color-thief.js`: CommonJS module. Entry point for Node.js and Browserify.
- `/dist/color-thief.mjs`: ES6 module. For modern browsers as well as Webpack and Rollup.
- `/dist/color-thief.min.js`: Duplicate of `/dist/color-thief.umd.js`. Kept around to maintain backwards compatibility.

2019-07-14 20:00:27 -07:00

1.2 KiB

Raw Blame History

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.umd.js: UMD module. For simple script tag loading that exposes a global variable or for RequireJS AMD support.
/dist/color-thief.js: CommonJS module. Entry point for Node.js and Browserify.
/dist/color-thief.mjs: ES6 module. For modern browsers as well as Webpack and Rollup.
/dist/color-thief.min.js: Duplicate of /dist/color-thief.umd.js. Kept around to maintain backwards compatibility.

Get the dominant color from an image

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

Build a color palette from an image

In this example, we build an 8 color palette.

var 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

1.2 KiB Raw Blame History