color-forge

Brewer

npm install color-brewer

A simple color system based on the work of https://github.com/dfcreative/color-space

Basic Usage

Creating a Color Instance

Colors can be made with the regular constructor pattern.

var color = new Color([255, 0, 0], 'rgb');

or

var color = Color.rgb([255, 0, 0]);

In addition, you can create a color from a hex code as follows.

Color.hex('#123');
Color.hex('123');
Color.hex('#112233');
Color.hex('112233');

See color-space for supported color spaces (it's pretty much all of them).

The format of a color object is as follows.

color {
	space,
	values
	[semi-private] originalColor
}

Converting Colors

color.convert('lab');

The result is a new object, and does not affect the original object. Additionally, the new object will store the original color, meaning unlimited conversions without loss.

assert.deepEqual(
    color.convert('lab').convert('hsl').convert('rgb').convert('xyz').values,
    color.convert('xyz').values
);

Mixing Colors

color1.mix(color2, [amount = 0.5, [mode = 'rgb']]);

Returns a new color object with the colors mixed according to amount (an amount of 0 gives color1, and 1 gives color2). Specifying a different mode will mix the color via that mode, allowing you to get even color spaces.

color1.mix(color2, 0.5, 'lab');

Color Operations

color1.add(color2);

All operations accept a color as the first and only argument. The available color operations are add, subtract, multiply, divide, screen, overlay, dodge, burn.

All operations are done via RGB.

Extra

color1.toString() // Gives a string like 'hsl(180, 60, 20)'
color1.toHex() // Gives the hex code