A small javascript library that helps you find the name of a color (Over 18K 🎨 color names).
npm install @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).
Cherangi (Che Rangi?) is a Farsi (Persian) sentence which means "What color?"
``bashUsing npm
$ npm install @distributed/cherangi --save
Usage
javascript
const cherangi = require("@distributed/cherangi");cherangi("#cfcfcf");
`$3
The returned value holds the color information and
if consists of a
, 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
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
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
to show the description of the current result.#### Returned Object (Sample)
##### Valid
`javascript
{
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
javascript
{
status: 1,
name: 'Black',
hex: '#000000',
delta: 0,
message: 'Exact Match'
}
`CLI
bash$ npm install --global @distributed/cherangi
+ @distributed/cherangi@VERSION
`bash
$ cherangi --help Usage
cherangi 'hexcode'
cherangi '#hexcode'
Example
cherangi 'fff'
cherangi '#fcfcfc'
``- 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
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.