consistent-color-generation

0.4.0 • Public • Published

Build Status codecov npm version

Consistent Color Generation

This node script generates colors given a string according to XEP-0392 0.6.

Features

Implemented

  • RGB color generation
  • Red/Blue-blindness correction
  • Blue-blindness correction

Not yet implemented

  • Adapting colors for a specific background color
  • Mapping to a color palette

How to use

Install all dependencies with yarn install and import the script as usual:

var getRGB = require('./consistent-color-generation');

Generate color without Color Vision Deficiency correction:

var color = getRGB('Foobar');
// color.r, color.g, color.b

Get css color string:

color.toString()      // rgb(0, 0, 0)
color.toString('hex') // #000000

Generate color with Red/Green-blindness correction:

var color = getRGB('Foobar', 'redgreen');

Generate color with Blue-blindness correction:

var color = getRGB('Foobar', 'blue');

You can also adjust the saturation and lightness:

var color = getRGB('Foobar', undefined, 80, 30);

Development

Install all dependencies with yarn install and run yarn test before every commit.

Readme

Keywords

none

Package Sidebar

Install

npm i consistent-color-generation

Weekly Downloads

121

Version

0.4.0

License

MIT

Unpacked Size

7.08 kB

Total Files

6

Last publish

Collaborators

  • sualko