npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

name-that-color-tr

v1.1.4

Published

Convert hexadecimal, RGB, HSL, LCH or CMYK color to a name and a shade with i18n support.

Downloads

8

Readme

Name That Color And Hue with I18n

Convert hexadecimal, RGB, HSL, LCH or CMYK color to a name and a shade with i18n support.

ntc-hi-js is a complete overhaul of Chirag Mehta and Colblindor work.

ntc-hi-js leverage the powerful chroma.js library to support a wider range of formats and offer more accurate matching.

Installation

Install directly:

npm i ntc-hi-js

Or add to your package.json

"ntc-hi-js": "^3.2.0"

Getting Started

const ntc = require('ntc-hi-js')

const n_match = ntc.name('#6195ED', 'en')

n_match.color.hex   // This is the RGB value of the closest matching color
n_match.color.name  // This is the text string for the name of the match
n_match.color.exact // True if exact color match, False if close-match

n_match.shade.hex   // This is the RGB value for the name of colors shade
n_match.shade.name  // This is the text string for the name of colors shade
n_match.shade.exact // True if exact color match, False if close-match

console.log(n_match) // [ '#6495ED', 'Cornflower Blue', false ]

Usage

Supported Formats

ntc-hi.js leverage the powerful chroma.js library to support a variety of formats. Any color information that fit into a single variable can be used directly:

ntc.name('619')                     // hex
ntc.name('#619')                    // hex
ntc.name('6195ED')                  // hex
ntc.name('#6195ED')                 // hex
ntc.name(0xff3399)                  // hex
ntc.name(16777215)                  // int
ntc.name([97, 149, 237])            // rgb
ntc.name({ r:97, g:149, g:237})     // rgb
ntc.name({ h:120, s:1, l:0.75})     // hsl
ntc.name({ l:80, c:25, h:200 })     // lch
ntc.name({ c:1, m:0.5, y:0, k:0.2}) // cmyk

If none of these format is satisfactory, it's also possible to directly pass a chroma.js color object. Please refer to their documentation for further information.

ntc.name(chroma(330, 1, 0.6, 'hsl'))

Translate into a target locale

Retrieving a translation is a simple parameter with the locale code.

ntc.name('#6195ED', 'fr')

If a locale table is not present, the fallback locale will be used. To change this fallback:

ntc.fallback_locale = 'en' // 'en' is the default fallback

Add your own color dictionary

A color dictionary is structured as a folder with a json object for each locale.

├── my_dictionary
│   ├── en.json
│   ├── fr.json
│   └── ...

The json object for a locale is a list of hex/name combos.

[
["FF0000", "Red"],
["FFA500", "Orange"],
["FFFF00", "Yellow"],
["008000", "Green"]
]

Once this is setup, you must register your dictionary path and launch a rebuild. The example also include the usage of a absolute path, which might be handy for moving the object around modules.

// with a relative path
ntc.dictionaries_path.my_dictionary = './my_dictionary'
// with an absolute path
ntc.dictionaries_path.my_dictionary = require('path').resolve('my_dictionary')
ntc.build_dictionaries()

Live Demo

Live demo of the original ntcjs library

http://chir.ag/projects/name-that-color/#6195ED

Live demo of the Colblindor's version with the hue feature

https://www.color-blindness.com/color-name-hue/

Running the Tests

Make sure you install the necessary dev dependencies needed to run the tests:

npm install

Then run the tests

npm test

Disclaimer

All credit goes to Chirag Mehta for creating the original ntc.js library.

Some credit goes to Colblindor for his hue modification.

Contributing

ntc-hi-js is an open source project and we encourage contributions.

To-Do

  • Support more locales
  • Review current locale for the quality of some translations