color-finder

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 10 Open GitHub ↗

Checks the distance between 2 hex colors

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# @sunpietro/color-finder

Checks the distance between 2 hex colors and finds the closest color to a given sample.

Looking for demo? [Check the demo page then](https://sunpietro.github.io/color-finder/).

If you want to know more how it's done, I suggest reading [this article](https://blog.piotrnalepa.pl/2020/09/01/how-to-find-a-similar-colour-in-your-colour-guidelines-with-javascript/).

## Installation

```bash
npm install @sunpietro/color-finder
```

## How to use it?

```typescript
import ColorFinder from `@sunpietro/color-finder`;

const colorsLibrary = [
  '#bb3300',
  '#aa22ff',
  '#b00053'
];
const finder = ColorFinder(colorsLibrary);
```

## Available methods

There are finder methods available:

### `updateColorsLibrary`

Updates a collection of colors used for comparing with sample colors. Takes one param: `colors` as `string[]`.

### `findClosestColor`

Finds the closest color to a sample color, in a colors library. Takes one param: `color` as `string`. Returns the closest color as `string`.

### `checkColorsSimilarity`

Compares 2 hex colors in terms of color similarity. Takes two params: `color1` as `string` and `color2` as `string`. Returns an Euclidean distance value as `number`. The lowest value, the more similar colors are.

color-finder

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README