Socket
Socket
Sign inDemoInstall

color-thief

Package Overview
Dependencies
75
Maintainers
2
Versions
8
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    color-thief

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


Version published
Weekly downloads
204
decreased by-20.62%
Maintainers
2
Install size
98.4 MB
Created
Weekly downloads
 

Readme

Source

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

Get the dominant color from an image

var colorThief = new ColorThief();
colorThief.getColor(sourceImage);
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.

var colorThief = new ColorThief();
colorThief.getPalette(sourceImage, 8);
getPalette(sourceImage[, colorCount, quality])
returns [ [num, num, num], [num, num, num], ... ]

Node.js

Install the module via npm

npm install color-thief

And use it:

var ColorThief = require('color-thief');

Node Tests

Run the node tests via npm test

Credits and license

Author

by Lokesh Dhakar
lokeshdhakar.com
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

  • Free for use in both personal and commercial projects.
  • Attribution requires leaving author name, author homepage link, and the license info intact.

FAQs

Last updated on 02 Jun 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc