mirror of
https://github.com/janishutz/color-thief.git
synced 2025-11-25 13:54:25 +00:00
75 lines
2.0 KiB
Markdown
75 lines
2.0 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 {r: num, g: num, b: 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], ... ]
|
|
```
|
|
|
|
##Credits and license
|
|
|
|
###Author
|
|
by Lokesh Dhakar
|
|
[lokeshdhakar.com](http://www.lokeshdhakar.com)
|
|
[twitter.com/lokesh](http://twitter.com/lokesh)
|
|
|
|
###Thanks
|
|
* Nick Rabinowitz - For creating quantize.js.
|
|
* John Schulz - For clean up and optimization. @JFSIII
|
|
* Nathan Spady - For adding drag and drop support to the demo page.
|
|
|
|
###License
|
|
Licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/)
|
|
|
|
* Free for use in both personal and commercial projects.
|
|
* Attribution requires leaving author name, author homepage link, and the license info intact.
|
|
|
|
|
|
## Changelog
|
|
|
|
### v2.0.1 - UNRELEASED
|
|
|
|
- [Fix] @nobodypb - MMCQ lib issues [#16](https://github.com/lokesh/color-thief/pull/16)
|
|
- [Fix] @nteike - [#33](https://github.com/lokesh/color-thief/pull/33)
|
|
- Drop version number from bower.json
|
|
- Fix incorrect bower.json main property path
|
|
|
|
### 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.
|
|
|
|
**Demo page and example changes**
|
|
|
|
- Don't show yellow circle buttons till images have loaded
|
|
- Add FB and Twitter buttons
|
|
- Add drag n drop support
|
|
- Make design responsive
|
|
- Touch support on demo page
|