0.0.0 • Published 9 months ago

@electrovir/color v0.0.0

Weekly downloads
-
License
(MIT or CC0 1.0)
Repository
github
Last release
9 months ago

@electrovir/color

A color package that wraps the culori package with an extremely simple API for color string parsing and color space/model conversion. It is primarily built for https://electrovir.github.io/color-picker-app.

Install

npm i @electrovir/color

Usage

All functionality is accessed through the Color class:

import {Color} from '@electrovir/color';

/** Create a new color instance by parsing any valid CSS color string. */
const color = new Color('#123');

/** Update an individual color format's coordinate */
color.set({
    hsl: {
        h: 100,
    },
});

/** Access the color values in multiple formats. */
console.info(color.hex); // #1c3311
console.info(color.rgb); // {r: 28, g: 51, b: 17}
console.info(color.lab); // {l: 18.6, a: -15, b: 18}

/** Express the color value as a valid CSS string. */
console.info(color.toCss().hsl); // hsl(100 50 13.3)

Supported color formats / spaces