Type Definitions

All exported types from the kleur library. See the Kleur Namespace for the full API surface.

import type {
  Rgb, Rgba, Hsl, Hsla,
  SolidColor, LinearGradient, RadialGradient, GradientStop, KleurFill,
  KleurValue, DistancePreset, DistanceOptions,
  BlendFn, BlendMode, KleurEaseFn, RandomOptions,
} from "@driangle/kleur";

Color Channel Types

Rgb

interface Rgb {
  r: number; // 0-255
  g: number; // 0-255
  b: number; // 0-255
}

Rgba

interface Rgba extends Rgb {
  a: number; // 0-1
}

Hsl

interface Hsl {
  h: number; // 0-360
  s: number; // 0-100
  l: number; // 0-100
}

Hsla

interface Hsla extends Hsl {
  a: number; // 0-1
}

Fill Types

SolidColor

interface SolidColor {
  type: "solid";
  color: Color;
}

LinearGradient

interface LinearGradient {
  type: "linear";
  x0: number;
  y0: number;
  x1: number;
  y1: number;
  stops: GradientStop[];
  globalAlpha?: number;
}

RadialGradient

interface RadialGradient {
  type: "radial";
  x0: number;
  y0: number;
  r0: number;
  x1: number;
  y1: number;
  r1: number;
  stops: GradientStop[];
  globalAlpha?: number;
}

GradientStop

interface GradientStop {
  offset: number; // 0-1
  color: Color;
}

GradientStopInput

interface GradientStopInput {
  offset: number;
  color: KleurValue; // string, number, or Color
}

Used as input to linearGradient() and radialGradient(). Colors are resolved to Color instances automatically.

KleurFill

type KleurFill = SolidColor | LinearGradient | RadialGradient;

Input Types

KleurValue

Any value accepted as a color input. All public functions on the kleur namespace that take a color parameter accept KleurValue, so you can pass hex strings, CSS strings, packed numbers, or Color instances directly:

type KleurValue = string | number | Color;

kleur.isLight("#ffffff");           // string
kleur.luminance(0xff6600);          // packed number
kleur.contrast("#000", kleur.white); // mix of string and Color

Distance Types

DistancePreset

type DistancePreset = "fast" | "perceptual" | "accurate" | "modern";

DistanceOptions

type DistanceOptions =
  | { preset: DistancePreset }
  | {
      space: "rgb" | "hsl" | "lab" | "lch" | "oklab" | "oklch";
      method: "euclidean" | "deltaE76" | "deltaE94" | "deltaE2000" | "deltaEOK";
    };

Blend Types

BlendFn

type BlendFn = (base: Color, overlay: Color) => Color;

A custom blend function that receives both full Color objects and returns a blended Color.

BlendMode

type BlendMode =
  | "multiply" | "screen" | "overlay"
  | "darken" | "lighten"
  | "colorDodge" | "colorBurn"
  | "hardLight" | "softLight"
  | "difference" | "exclusion"
  | "add" | "subtract"
  | BlendFn;

KleurEaseFn

type KleurEaseFn = (t: number) => number;

Random Types

RandomOptions

interface RandomOptions {
  hue?: "warm" | "cool" | [number, number];
  saturation?: [number, number];
  lightness?: [number, number];
  alpha?: number;
}