Utilities

token

Parses any recognizable color to the specified format.

import { token } from "@skchr/color";

// Convert to hex string (default)
token("cyan"); // "#00ffff"

// Convert to object
token("cyan", { kind: "obj", targetMode: "lch" });

// Convert to array
token("cyan", { kind: "arr" });

// Convert to number
token("cyan", { kind: "num" });
Copy

alpha

Gets or sets the alpha channel of a color.

import { alpha } from "@skchr/color";

// Get alpha
alpha("#a1bd2f0d"); // 0.050980392156862744

// Set alpha
alpha("b2c3f1", 0.5); // "#b2c3f180"
Copy

luminance

Gets or sets the luminance of a color.

import { luminance } from "@skchr/color";

// Get luminance
luminance("#a1bd2f"); // 0.4417749513730954

// Set luminance
luminance("#a1bd2f", 0.5);
Copy

lightness

Darkens or lightens a color.

import { lightness } from "@skchr/color";

// Lighten
lightness("blue", { amount: 0.3 }); // "#464646"

// Darken
lightness("blue", { amount: 0.3, darken: true });
Copy

family

Returns the hue family of a color.

import { family } from "@skchr/color";

family("#310000"); // "red"
family("blue"); // "blue"
Copy

temp

Returns whether a color is cool or warm.

import { temp } from "@skchr/color";

temp("blue"); // "cool"
temp("red"); // "warm"
Copy

achromatic

Checks if a color is grayscale.

import { achromatic } from "@skchr/color";

achromatic("gray"); // true
achromatic("pink"); // false
Copy

mc

Gets or sets a specific channel value.

import { mc } from "@skchr/color";

// Get RGB green channel
mc("rgb.g")("#a1bd2f"); // 0.7411764705882353

// Set channel
mc("lch.l")("blue", 50);
Copy