Skip to content
This repository has been archived by the owner on Feb 10, 2022. It is now read-only.

derTobsch/stringToColor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

62 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status devDependency Status String to Color

Tiny library to generate the same nice hex color for a string in Javascript.

###Features

  • Sexy colors, not muddy browns and boring grays
  • Binary safe

###Demo

http://dertobsch.github.io/stringToColor/

Why it needed to exist

I needed a way to generate a consistent NICE color for any given word to assign a tag it's own independent color (without knowing what all tags are).

How to use it

####Bower

Add it to your bower.json

...
"dependencies": {
    "string-to-color": "^1.0.1"
}
...

####EcmaScript 6 (ES6)

StringToColor Is realized as an EcmaScript 6 Module. You can find the ES6 Module in

dist/string-to-color.js

####Universal Module Definition (UMD)

The pattern is admittedly ugly, but is both AMD and CommonJS compatible, as well as supporting the old-style “global” variable definition.

If your engines do not support EC6 you can use the UMD Module

dist/string-to-color.umd.js

###Development

Get all dependencies via npm

npm install

You can run all tasks via Grunt by typing

grunt

it will

  • lint the files with eslint
  • run all tests via mocha
  • convert the ES6 Module via babel into an UMD Module
  • finally copy the ES6 and the UMD Modules into /dist

###License

String to color is licensed under the Apache License 2.0

About

Consistently generate the same color for a specific string

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%