mirror of
https://github.com/janishutz/color-thief.git
synced 2025-11-26 06:14:25 +00:00
b0bde62d91
The README erroneously stated that getColor would return a js object with 'r', 'g' and 'b' members, instead it returns an array just like getPalette.
51 lines
1.5 KiB
Markdown
51 lines
1.5 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
|
|
|
|
###Get the dominant color from an image
|
|
```js
|
|
var colorThief = new ColorThief();
|
|
colorThief.getColor(sourceImage);
|
|
```
|
|
|
|
```js
|
|
getColor(sourceImage[, quality])
|
|
returns [num, num, num]
|
|
```
|
|
|
|
###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);
|
|
```
|
|
|
|
```js
|
|
getPalette(sourceImage[, colorCount, quality])
|
|
returns [ [num, num, num], [num, num, num], ... ]
|
|
```
|
|
|
|
|
|
## Changelog
|
|
|
|
### v2.0.1 - UNRELEASED
|
|
|
|
- [Fix] MMCQ lib issues [#16](https://github.com/lokesh/color-thief/pull/16) by @nobodypb
|
|
- [Fix] Incorrect bower.json main property path. [#37](https://github.com/lokesh/color-thief/pull/37) by @chellem, @joscha, @dkushner
|
|
- [Fix] Quality less than 1 causes infinite loop [#33](https://github.com/lokesh/color-thief/pull/33) by @nteike
|
|
- [Fix] MMCQ.quantize(...) can return false or undefined thus breaking the application (#55)[https://github.com/lokesh/color-thief/pull/55] by @mhahmadi
|
|
- [Remove] Drop version number from bower.json [#70](https://github.com/lokesh/color-thief/pull/70) by @kkirsche
|
|
|
|
### v2.0.0 - 2013-06-23
|
|
|
|
- Embed quantize into color thief file
|
|
- Strip out jQuery requirement
|
|
- Credit those who helped with edits - Nathan Spady for drag and drop support.
|