mirror of
https://github.com/janishutz/color-thief.git
synced 2025-11-25 13:54:25 +00:00
c91f3e808e
- `/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.
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
# 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](http://lokeshdhakar.com/projects/color-thief) | [Read more on my blog](http://lokeshdhakar.com/color-thief)
|
|
|
|
## 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
|
|
|
|
```js
|
|
var colorThief = new ColorThief();
|
|
colorThief.getColor(sourceImage);
|
|
```
|
|
|
|
### Build a color palette from an image
|
|
|
|
In this example, we build an 8 color palette.
|
|
|
|
```js
|
|
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 |
|