# main-colors-picker

> Get the main colors from an array of colors.

Latest version **1.0.1** (published 2020-08-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install main-colors-picker
pnpm add main-colors-picker
yarn add main-colors-picker
bun add main-colors-picker
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2020-08-02 |
| First published | 2020-08-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 27.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Leonardo Salazar |
| Maintainers | lsalazarm99 |
| Keywords | colors, main colors |

## Links

- npm: https://www.npmjs.com/package/main-colors-picker
- Repository: https://github.com/lsalazarm99/main-colors-picker
- Homepage: https://github.com/lsalazarm99/main-colors-picker#readme
- Issues: https://github.com/lsalazarm99/main-colors-picker/issues
- npm.io page: https://npm.io/package/main-colors-picker

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2020-08-02
- 1.0.0 — 2020-08-02

## README

# main-colors-picker

`main-colors-picker` is a tool to which you give an array of colors and this returns its main colors. A color is just
 an array of 3 numbers whose values are from 0 to 255. Yes, they are the RGB values!
 
 ```js
const mainColors = [[25, 50, 75], [3, 120, 60], [90, 27, 9], [210, 160, 180]];
```
 
The main colors are selected by color spectrum and number of colors.

Keep in mind that this tool is intended to receive an array of colors from, for example, an image, where the same
 color could be repeated many times. How to get these colors? Take a look at:
- [`image-to-colors`](https://www.npmjs.com/package/image-to-colors)
 
## Installation
Just run:
```bash
npm install main-colors-picker
```

## Usage

It is pretty straightforward:
```js
import MainColorsPicker from "main-colors-picker";
import ImageToColors from "iamge-to-colors"; // Using image-to-colors to get the colors from an image.

const image = document.getElementById('myImage');
const colors = ImageToColors.get(image);

const mainColors = MainColorsPicker.get(colors);
```

## Configuration

You can pass a second argument with some adjustments you want to make for color selection.

```js
{
  // A number from 1 to 256 that represents how much the colors will be grouped before color selection.
  colorsVarietyLevel: number;

  // Indicates how the colors should to be selected.
  mode: MainColorsPickerMode.average || MainColorsPickerMode.frequency;
}
```

## How does it work?

Glad you ask!
1. We group the colors by color spectrum based on a colors variety level parameter.
2. The groups of colors are sorted according to the number of colors they contain, from highest to lowest.
3. From each group of color we obtain the average or most frequent color. The resulting list represents the main colors.

This idea is inspired by:
- [`albumcolors`](https://github.com/chengyin/albumcolors) — From [@chengyin](https://github.com/chengyin)

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