# @moezx/colorthief

> Get the dominant color or color palette from an image.

Latest version **2.3.2-1** (published 2021-05-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install @moezx/colorthief
pnpm add @moezx/colorthief
yarn add @moezx/colorthief
bun add @moezx/colorthief
```

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: esm support; no vulnerabilities; popular repo.

Warnings: low downloads; no types.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.3.2-1 |
| Published | 2021-05-11 |
| First published | 2021-05-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 543.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13663 |
| Author | Lokesh Dhakar |
| Maintainers | mashirozx |
| Keywords | color, palette, sampling, image, picture, photo, canvas |

## Links

- npm: https://www.npmjs.com/package/@moezx/colorthief
- Repository: https://github.com/lokesh/color-thief
- Homepage: http://lokeshdhakar.com/projects/color-thief/
- Issues: https://github.com/lokesh/color-thief/issues
- npm.io page: https://npm.io/package/@moezx/colorthief

## Dependencies (2)

- [@moezx/quantize](https://npm.io/package/@moezx/quantize.md) ^1.2.0
- [@moezx/get-pixels](https://npm.io/package/@moezx/get-pixels.md) ^4.0.0

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 2.3.2-1 (latest) — 2021-05-11
- 2.3.2 — 2021-05-11

## README

# Color Thief

Grab the color palette from an image using just Javascript.Works in the browser and in Node.

### View the [demo page](https://lokeshdhakar.com/projects/color-thief/) for examples, API docs, and more.

---

## Contributing

### Project structure

+ `build/` - Simple script that copies and renames files into the /dist folder.
+ `cypress/` - Browsers tests.
+ `dist/` - Generated distribution files created by [microbundle](https://github.com/developit/microbundle) package and a couple of files copied via build script.
+ `examples/` - CSS, JS, and Images for the index.html example page.
+ `src/color-thief-node.js` - Source for the Node (commonjs) compatible version of the script.
+ `src/color-thief.js` - Source for the browser (ES6, AMD, Global var) compatible version of the script.
+ `src/core.js` - Functions shared between the node and browser versions of the script.
+ `test/` - Node integration tests. Uses Chai.
+ `index.html` - Example page.

### Running tests

There are two sets of tests:

1. Browser tests run with [Cypress](https://www.cypress.io)
2. Node tests run with [Karma](https://karma-runner.github.io/latest/index.html) and utilizing [Mocha](https://mochajs.org/)

To run both the browser and Node tests:

- `npm run dev` to start local server.
- `npm run test`

To run just the browser tests with the Cypress UI:

- `npm run dev` to start local server
- `npm run test:browser`

To run just the Node tests:

- `npm run test:node`


### Adding tests

- Update `cypress/test-pages/index.html` as needed or create a new test page if you need new examples.
- Add new tests in `cypress/integration/apis_spec.js`

### Making a new release

- Merge `dev` into `master`
- Pull down `master`
- Update version number in `src/color-thief.js` and `package.json`
- Run `npm run build`
- Commit and push built files back up to `master`
- Create a new Github release along with tag. Naming convention for both ```v2.8.1```
- `npm publish`

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