Class Color

Public

Constructors

constructor

Properties

colors options convertHexToHsl convertHexToRgb convertHslToHex convertHslToRgb convertRgbToHex convertRgbToHsl isValidHex isValidHsl isValidRgb overlapColors

Methods

computeHex computeHsl hex hsl isDark isLight luminance rgb computeLuminance computeOpaqueColorLuminance convertUnknownToRgb create

Constructors

Protectedconstructor

Properties

Protectedcolors

colors: {
    hex: null | `#${string}`;
    hsl: null | Required<HSL>;
    rgb: Required<RGB>;
}

Protectedoptions

options: PrecisionOptions

StaticconvertHexToHsl

convertHexToHsl: ((color: `#${string}`, options?: PrecisionOptions & AlphaPrecisionOptions) => Required<HSL>)

StaticconvertHexToRgb

convertHexToRgb: ConvertHexToRgb

StaticconvertHslToHex

convertHslToHex: ((color: HSL) => `#${string}`)

StaticconvertHslToRgb

convertHslToRgb: ConvertHslToRgb

StaticconvertRgbToHex

convertRgbToHex: ConvertRgbToHex

StaticconvertRgbToHsl

convertRgbToHsl: ConvertRgbToHsl

StaticisValidHex

isValidHex: ((color: unknown) => color is `#${string}`)

StaticisValidHsl

isValidHsl: ((color: unknown) => color is HSL)

StaticisValidRgb

isValidRgb: ((color: unknown) => color is RGB)

StaticoverlapColors

overlapColors: OverlapColors

Methods

ProtectedcomputeHex

  • computeHex(): `#${string}`

  • Returns `#${string}`

ProtectedcomputeHsl

  • computeHsl(): Required<HSL>

  • Returns Required<HSL>

hex

  • hex(): `#${string}`

  • Returns `#${string}`

hsl

  • hsl(): Required<HSL>

  • Returns Required<HSL>

isDark

  • isDark(options?): boolean

  • Parameters

    Returns boolean

isLight

  • isLight(options?): boolean

  • Parameters

    Returns boolean

luminance

  • luminance(options?): number

  • Parameters

    Returns number

rgb

  • rgb(): {
        a: number;
        b: number;
        g: number;
        r: number;
    }

  • Returns {
        a: number;
        b: number;
        g: number;
        r: number;
    }

    • a: number
    • b: number
    • g: number
    • r: number

StaticcomputeLuminance

  • computeLuminance(color, options?): number

  • Parameters

    Returns number

Protected StaticcomputeOpaqueColorLuminance

  • computeOpaqueColorLuminance(color): number

  • Parameters

    Returns number

StaticconvertUnknownToRgb

Staticcreate

On This Page

Constructors
Properties
Methods