@distributed/cherangi

Fork from shariati/cherangi, using dependabot to automatically update the color-name-list package.

A small javascript library that helps you find the name of a color (Over 18K 🎨 color names).

Meaning

Cherangi (Che Rangi?) is a Farsi (Persian) sentence which means "What color?"

Install

# Using npm
$ npm install @distributed/cherangi --save

# Using yarn
yarn add @distributed/cherangi

Usage

const cherangi = require("@distributed/cherangi");

cherangi("#cfcfcf");

About Returned Object

The returned value holds the color information and if consists of a status , name, hex, delta and a message

Status

Holds the status information of the results which could be one of the following

Status Code	Status Description
0	Exact Match
2	Not perceptible by human eyes.
4	Perceptible through close observation.
8	Perceptible at a glance.
-1	No Color match found

Name

A <string> that represents the color name of the input value if no exact match has been found then the most similar color will be returned.

Hex

A <string> that returns the matched color / similar color code in hex

Delta (E 76)

Delta E is a metric for understanding how the human eye perceives color difference. The term delta comes from mathematics, meaning change in a variable or function. The suffix E references the German word Empfindung, which broadly means sensation.

• Source: http://zschuessler.github.io/DeltaE/learn/#toc-defining-delta-e

Message

A <string> to show the description of the current result.

Returned Object (Sample)

Valid

{
 status: 8,
 name: 'Neon Green',
 hex: '#39ff14',
 delta: 2.8270216256677023,
 message: 'Perceptible at a glance'
}

Invalid Input

For now all invalid inputs are handled as black color. This will be changed with a proper staus code in near future

{
 status: 1,
 name: 'Black',
 hex: '#000000',
 delta: 0,
 message: 'Exact Match'
}

CLI

$ npm install --global @distributed/cherangi

+  @distributed/cherangi@VERSION

$ cherangi --help

  Usage
    cherangi 'hexcode'
    cherangi '#hexcode'

  Example
    cherangi 'fff'
    cherangi '#fcfcfc'

Thanks to

• Amin Author of Cherangi
• David Aerne for the awesome list of color names.
• EasyRGB.com for providing the formulas
• Zachary Schuessler for the helpful blog about Delta

Disclaimer

Please note cherangi uses color-names for the list of colors and in the process of creating this list the author tries to remove all names that are offensive or racist, as well as protect brandnames. As some of the color names come from other lists, it might happen that some bad ones slip in. Please report them, they will be removed as quickly as possible.