@thi.ng/color/api/ranges.d.ts

Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets

import type { Range } from "@thi.ng/api";
import type { IRandom } from "@thi.ng/random";
import type { ReadonlyColor } from "../api.js";
import type { CSSColorName } from "./names.js";
export type ColorRangePreset = "light" | "dark" | "bright" | "weak" | "neutral" | "fresh" | "soft" | "hard" | "warm" | "cool" | "intense";
export interface ColorRange {
    /**
     * Hue ranges
     */
    h?: Range[];
    /**
     * Saturation ranges
     */
    c?: Range[];
    /**
     * Brightness ranges
     */
    l?: Range[];
    /**
     * Alpha ranges
     */
    a?: Range[];
    /**
     * Black point ranges
     */
    b?: Range[];
    /**
     * White point ranges
     */
    w?: Range[];
}
export interface ColorRangeOpts {
    /**
     * Nunber of result colors.
     *
     * @defaultValue ∞
     */
    num: number;
    /**
     * Base color. Either a {@link TypedColor} instance, {@link CSSColorName} or
     * raw LCH tuple. Its hue will be used as bias to create a randomized
     * variation (based on {@link ColorRangeOpts.variance}).
     */
    base?: ReadonlyColor | CSSColorName;
    /**
     * Max. normalized & randomized hue shift for result colors. Only used if a
     * base color is given.
     *
     * @defaultValue 0.025 (i.e. +/- 9 degrees)
     */
    variance: number;
    /**
     * Tolerance for grayscale check (used for both saturation and brightness).
     *
     * @defaultValue 0.001
     */
    eps: number;
    /**
     * PRNG instance to use for randomized values
     *
     * @defaultValue
     * [`SYSTEM`](https://docs.thi.ng/umbrella/random/variables/SYSTEM.html)
     */
    rnd: IRandom;
}
export interface ColorThemePart {
    /**
     * Color range spec to use
     */
    range?: ColorRange | ColorRangePreset;
    /**
     * Base color. Either a {@link TypedColor} instance, {@link CSSColorName} or
     * raw LCH tuple.
     */
    base?: ReadonlyColor | CSSColorName;
    /**
     * Relative weight of this theme part
     *
     * @defaultValue 1.0
     */
    weight?: number;
}
export type ColorThemePartTuple = [ColorRangePreset, CSSColorName, number?] | [ColorRangePreset | CSSColorName, number?] | ColorRangePreset | CSSColorName;
//# sourceMappingURL=ranges.d.ts.map