Class Color

Simple object representing an RGBA color can be initialized from any valid CSS Expression

Constructors

constructor

new Color(color: string): Color
Parameters
- color: string
Returns Color

Methods

getBrightness

getBrightness(): number
calculates the colors brightness (0-255) http://www.w3.org/TR/AERT#color-contrast

Returns number

getContrastRatio

getContrastRatio(color: string | Color): number
compares color with specified one and returns the color contrast defined by (WCAG Version 2)
Parameters
- color: string | Color
Returns number

getFormat

getFormat(): string
returns the colors original format possible values: rgb, rgba, hsl, hsla, hex6, hex3, name

Returns string

getInput

getInput(): string
returns the original input value

Returns string

getLuminance

getLuminance(): number
retrieve the colors luminance http://www.w3.org/TR/2008/REC-WCAG20-20081211/#relativeluminancedef

Returns number

getOpaqueColor

getOpaqueColor(opacity?: number): Color
returns an opaque representation of this color
Parameters
- Optionalopacity: number
  optional opacity ranging from 0 (fully transparent) to 1 (fully opaque). default is 1.
Returns Color

getRGBA

getRGBA(): { a: number; b: number; g: number; r: number }
returns the color in RGBA format rgb are in range [0-255] a is in range [0-1]

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

getTextColor

getTextColor(): Color
returns the "best" text color (either white or black) for use on a background of this color algorithm always ensures a minimum contrast ratio of 3:1 as per [ISO-9241-3] and [ANSI-HFES-100-1988]

Returns Color

isTransparent

isTransparent(): boolean
check if color is transparent

Returns boolean

isValid

isValid(): boolean
Returns boolean

toCompressedString

toCompressedString(): string
returns the most compact representation of the input value

Returns string

toString

toString(): string
returns the original input value

Returns string

`Static`compress

compress(expression: string): string | null
Parameters
- expression: string
Returns string | null

`Static`getOpaqueColor

getOpaqueColor(color: string | Color, opacity?: number): string
returns an opaque representation of the specified color
Parameters
- color: string | Color
- Optionalopacity: number
  optional opacity ranging from 0 (fully transparent) to 1 (fully opaque). default is 1.
Returns string

`Static`getTextColor

getTextColor(color: string | Color): string
returns the "best" text color (either white or black) for use on a background of this color algorithm always ensures a minimum contrast ratio of 3:1 as per [ISO-9241-3] and [ANSI-HFES-100-1988]
Parameters
- color: string | Color
Returns string

`Static`isEqual

isEqual(color1: string | Color, color2: string | Color): boolean
Parameters
- color1: string | Color
- color2: string | Color
Returns boolean

`Static`isTransparent

isTransparent(color?: string | null): boolean
check if specified color is transparent
Parameters
- Optionalcolor: string | null
Returns boolean

`Static`parse

parse(expression?: string | null): Color | null
Parameters
- Optionalexpression: string | null
Returns Color | null

`Static`random

random(
    saturation?: number,
    lightness?: number,
    steps?: number,
    step?: number,
): string
return a random color with the specified brightness
Parameters
- Optionalsaturation: number
  saturation of the color. default 0.9
- Optionallightness: number
  lightness of the color. default 0.6
- Optionalsteps: number
  number of steps. default 30 (12 degree each)
- Optionalstep: number
  index of a specific step. randomized by default
Returns string

`Static`validate

validate(expression: string): boolean
Parameters
- expression: string
Returns boolean