Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shariati/cherangi
A small javascript library that finds an exact or similar color name.
https://github.com/shariati/cherangi
colors javascript javascript-library nodejs npm npm-package
Last synced: 2 months ago
JSON representation
A small javascript library that finds an exact or similar color name.
- Host: GitHub
- URL: https://github.com/shariati/cherangi
- Owner: shariati
- License: mit
- Created: 2017-08-27T10:30:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T10:26:46.000Z (12 months ago)
- Last Synced: 2024-10-10T07:46:46.381Z (3 months ago)
- Topics: colors, javascript, javascript-library, nodejs, npm, npm-package
- Language: JavaScript
- Size: 1.81 MB
- Stars: 19
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cherangi
[](https://badge.fury.io/js/cherangi)
[](https://snyk.io/test/github/shariati/cherangi)
A small javascript library that helps you find the name of a color (Over 29K 🎨 color names, Thanks to color-name-list package )..
## Meaning
Cherangi (Che Rangi?) is a Farsi (Persian) sentence which means "What color?"
## Install
```bash
$ npm install cherangi --save
+ cherangi@VERSION
```
## Usage
```javascript
const cherangi = require("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 `` 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](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 cherangi
+ cherangi@VERSION
```
```bash
$ cherangi --help
Usage
cherangi 'hexcode'
cherangi '#hexcode'
Example
cherangi 'fff'
cherangi '#fcfcfc'
```
## Thanks to
- [David Aerne](https://github.com/meodai/color-names) for the awesome list of color names.
- [EasyRGB.com](http://www.easyrgb.com/en/math.php) for providing the formulas
- [Zachary Schuessler](https://github.com/zschuessler) for the helpful blog about [Delta](http://zschuessler.github.io/DeltaE/learn/#toc-defining-delta-e)
## Disclaimer
Please note _cherangi_ uses [color-names](https://github.com/meodai/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](https://github.com/meodai/color-names/issues), they will be removed as quickly as possible.