Overview

Cvet (Russian word for "color", pronounced /tsvet/) is a color tool for customizing and picking colors easily for your projects. It consists of various palettes & filters along with tools to help you with tough times picking colors for your projects.

Install

$ npm install cvet
$ yarn add cvet
$ pnpm add cvet

Usage

To work with palette or filters you have to declare classes (Filter class extends Palette):

import { Palette, Filter } from "cvet"; // esm
const { Palette, Filter } = require("cvet"); // or cjs

const color = new Palette("#FF0000");
const filterColor = new Filter({
  r: 255,
  g: 0,
  b: 0,
});

// Or you can optionally provide a color type to treat the color as you want:
const detectedColor = new Palette("#FF0000", "HEX");
const detectedFilterColor = new Filter(
  {
    r: 255,
    g: 0,
    b: 0,
  },
  "RGB"
);

Instead you can use shorthand functions to get the same results:

import { palette, filter } from "cvet"; // esm
const { palette, filter } = require("cvet"); // or cjs  

const functionColor = palette("#FF0000");
const functionFilterColor = filter("#FF0000");

Parameters

Both classes require 1 single color parameter & an optional color type to treat the color strictly.

There are 7 color types you can use as second parameter:

• HEX - Written as string ("#FF0000" or #FF000033)
• RGB - Written as an object with r, g, b keys ({ r: 255, g: 0, b: 0 })
• RGBA - Written as an object same as RGB but with alpha channel key ({ r: 255, g: 0, b: 0, a: 20 })
• HSL - Written as an object as well with corresponding keys ({ h: 0, s: 100, l: 50 })
• HSLA - Written as an object same as HSL but with alpha channel key ({ h: 0, s: 100, l: 50, a: 20 })
• CMYK - Written the same as RGB & HSL ({ c: 0, m: 100, y: 100, k: 0 })
• MAP - Is basically RGB

Getters

As Filter extends Palette, there are more than enough same getters working for both classes:

console.log(color.color); // Returns RGB color (MAP), console logging the class would just return instance
console.log(color.red); // Returns red value in the color
console.log(color.green); // Returns green value in the color
console.log(color.blue); // Returns blue value in the color
console.log(color.alpha); // Returns alpha channel value in the color, if no alpha then it will return null
console.log(color.hex); // Returns converted MAP to HEX
console.log(color.rgb); // Returns RGB, will cut the alpha part
console.log(color.rgba); // Returns RGBA
console.log(color.hsl); // Returns converted MAP to HSL, will cut the alpha part
console.log(color.hsla); // Returns converted MAP to HSL
console.log(color.cmyk); // Returns converted MAP to CMYK

Filter class on the other hand is only extended with filter functions so these are the getters you can use.

Other than that there's obviously a way to set a new color for the instance:

color.color = {
  r: 0,
  g: 255,
  b: 255
};

color.color = "#0000FF";

However it won't let you treat color types as you want. Instead it will detect the color type. For instance, providing another color type not matching the initial one won't break anything in your code.

Types

For type usage please head to a separate @cvet/types package. It is essentially a provider of color types for the cvet package:

import type { HEX } from "cvet/types"; // with package usage
import type { HEX } from "@cvet/types"; // with types dependency usage

const color: HEX = "#FF0000";

Filters

There are 7 filters for your colors you can use: contrast, grayscale, invert, lighten, darken, rotateHue, saturate.

Each of those have different parameters - as the result these methods return the instance so that to invert the color you need to do following actions:

const color = new Filter("#FF0000");

console.log(color.rgb); // { r: 255, g: 0, b: 0 }
console.log(color.invert().rgb); // { r: 0, g: 255, b: 255 }
console.log(color.rgb); // { r: 0, g: 255, b: 255 }

As you can see the instance changes as filter is applied.

Here's a parameter list for each of the filter:

• contrast - An amount to adjust the contrast of the color (0-100+)
• grayscale - An amount to adjust the grayscale of the color where 0 is complete grayscale (0-100)
• invert - No parameters needed
• lighten - An amount to lighten the color (0-100)
• darken - An amount to darken the color (0-100)
• rotateHue - Degree to rotate the hue (0-360)
• saturate - An amount to saturate the color by (0-100)
• blend - Second RGB or RGBA color & an amount to blend the color (0-100)

Tools

There's a bunch of tools you can use. One is combination function that accepts 2 parameters:

• Amount of colors in a combination (default: 2)
• Color of the initial color, can be any model e.g. HEX (default: random)

import { combination } from "cvet"; // esm
const { combination } = require("cvet"); // or cjs

console.log(combination(3, "#ffd301"));
console.log(combination(3, { r: 255, g: 211, b: 1 })); // Or via RGB
// Both return same value - ["#ffd301", "#01ffd3", "#d301ff"]

Tools like complementary, triade, square, rainbow work almost identically except these have combination amount preset:

• complementary returns an opposite (not inverse) color in an array of the initial color & itself
• triade returns a triade (3) array of colors with a provided initial color
• square acts the same and returns a square (4) array of colors with a provided initial color
• rainbow returns a full rainbow (7) array of colors with a provided initial color

Note Unlike combination tools above require a single parameter - color of any model (no default value set).

Other than these there's an analogous tool to return analogous colors (30 degrees rotated hue clockwise & counterclockwise):

import { analogous } from "cvet"; // esm
const { analogous } = require("cvet"); // or cjs

console.log(analogous("#62c62c"));
// Returns ["#62c62c", "#2cc643", "#afc62c"]

Also you can use shades, tints, tones to generate arrays (with quantity provided, default is 8) of colors:

import { shades, tints, tones } from "cvet"; // esm
const { shades, tints, tones } = require("cvet"); // or cjs

console.log(shades("#62c62c"));
// Returns ["#62c62c", "#57b027", "#4c9a22", "#41841d", "#366e18", "#2b5813", "#20420e", "#152c09"]
console.log(shades("#62c62c", 10));
// Returns ["#62c62c", "#59b428", "#50a224", "#479020", "#3e7e1c", "#356c18", "#2c5a14", "#234810", "#1a360c", "#112408"]
console.log(tints("#62c62c"));
// Returns ["#62c62c", "#71d43c", "#83d954", "#95de6c", "#a7e384", "#b8e99c", "#c9eeb4", "#daf4cc"]
console.log(tints("#62c62c", 10));
// Returns ["#62c62c", "#6ed338", "#7dd74c", "#8bdb60", "#99df74", "#a8e488", "#b7e99c", "#c5edb0", "#d4f2c4", "#e3f6d8"]
console.log(tones("#62c62c"));
// Returns ["#62c62c", "#66bd37", "#6ab541", "#6dac4c", "#71a356", "#759a61", "#79926b", "#7c8976"]
console.log(tones("#62c62c", 10));
// Returns ["#62c62c", "#65bf34", "#68b83d", "#6bb145", "#6eaa4e", "#71a356", "#749c5e", "#779567", "#7a8e6f", "#7d8778"]

Utilities

There are also some utilities that would ease your work with the package:

• Hue/HEX/HSL/CMYK to RGB converters - hexToRgb(HEX), hslToRgb(HSL) etc.
• Finding the luminosity of the color - luminosity(RGB)
• Random HEX color picker - randomColor()
• ~~00 pad for HEX - padHEX(R/G/B value of HEX)~~
• Color converter to css string - stringify(color)
• Color model detector from the given value, returns type as string - detect(color)

Warning As an alternative to padHEX please use shifting method - (x | 1 << 8).toString(16).slice(1). Soon the utility will be removed.

Documentation

All the available documentation regarding the usage of the package is in jsdoc of each / types.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is under MIT license. You can freely use it for your own purposes.