https://github.com/shime/dominant-color

Gets dominant color of an image.
https://github.com/shime/dominant-color

Last synced: about 1 year ago
JSON representation

Gets dominant color of an image.

• Host: GitHub
• URL: https://github.com/shime/dominant-color
• Owner: shime
• License: mit
• Created: 2014-10-16T22:38:39.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2016-09-24T09:10:30.000Z (over 9 years ago)
• Last Synced: 2025-04-09T03:25:40.683Z (about 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 1.11 MB
• Stars: 63
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dominant-color

[![Build Status](https://travis-ci.org/shime/dominant-color.svg)](https://travis-ci.org/shime/dominant-color)

Gets dominant color of an image. ~10 times faster than [color-thief](https://www.npmjs.org/package/color-thief) because it uses plain old [imagemagick](https://www.npmjs.org/package/imagemagick) instead of canvas.

## Installation

    npm install dominant-color

## Example

```javascript

var color   = require('dominant-color'),

    imgPath = './path/to/your/image.jpg'

color(imgPath, function(err, color){

  // hex color by default

  console.log(color) // '5b6c6e'

})

color(imgPath, {format: 'rgb'}, function(err, color){

  console.log(color) // ['91', '108', '110']

})

```

Options: 

* `format` - 'hex' or 'rgb', defaults to 'hex'

## Alternatives

* [color-thief](https://www.npmjs.org/package/color-thief)

* [colour-extractor](https://www.npmjs.org/package/colour-extractor)

## License

MIT