# color-sieve

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

Latest version **1.0.1** (published 2019-02-13) · BSD-2-Clause license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install color-sieve
pnpm add color-sieve
yarn add color-sieve
bun add color-sieve
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2019-02-13 |
| First published | 2018-02-22 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 514.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | james1x0 |

## Links

- npm: https://www.npmjs.com/package/color-sieve
- Repository: https://github.com/James1x0/color-thief
- Homepage: https://github.com/James1x0/color-thief#readme
- Issues: https://github.com/James1x0/color-thief/issues
- npm.io page: https://npm.io/package/color-sieve

## Dependencies (1)

- [canvas](https://npm.io/package/canvas.md) 1.6.13

## Recent versions

- 1.0.1 (latest) — 2019-02-13
- 1.0.0 — 2018-02-22

## README

# 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], ... ]
```

### Node.js
Install the module via npm
```bash
npm install color-thief
```
And use it:
```js
var ColorThief = require('color-thief');
```

### Node Tests
Run the node tests via `npm test`

## 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.

---
_Source: https://npm.io/package/color-sieve · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._