Class Color

Index

Constructors

Methods

bestContrastForeground contrastRatio to from

Constructors

constructor

new Color(r: number, g: number, b: number, a?: number): Color
Parameters
- r: number
- g: number
- b: number
- a: number = 1
Returns Color
- Defined in tools/ColorConverter.ts:114

Methods

bestContrastForeground

bestContrastForeground(): Color
Pick black or white as the ideal foreground based on WCAG contrast ratio.

Returns Color
- Defined in tools/ColorConverter.ts:210

contrastRatio

contrastRatio(other: Color): number
Contrast ratio between this color and another: (L1 + 0.05) / (L2 + 0.05), L1 ≥ L2
Parameters
- other: Color
Returns number
- Defined in tools/ColorConverter.ts:200

to

to(type: "hsl"): HslArrayType
Parameters
- type: "hsl"
Returns HslArrayType
- Defined in tools/ColorConverter.ts:158
to(type: "rgb"): RgbArrayType
Parameters
- type: "rgb"
Returns RgbArrayType
- Defined in tools/ColorConverter.ts:159
to(type: "hsla"): HslaArrayType
Parameters
- type: "hsla"
Returns HslaArrayType
- Defined in tools/ColorConverter.ts:160
to(type: "rgba"): RgbaArrayType
Parameters
- type: "rgba"
Returns RgbaArrayType
- Defined in tools/ColorConverter.ts:161
to(type: "hex"): string
Parameters
- type: "hex"
Returns string
hex without #
- Defined in tools/ColorConverter.ts:163
to(type: "hexa"): string
Parameters
- type: "hexa"
Returns string
hex(a) without #
- Defined in tools/ColorConverter.ts:165

`Static`from

from(type: "hex", value: string | number): Color
Parameters
- type: "hex"
- value: string | number
Returns Color
- Defined in tools/ColorConverter.ts:121
from(type: "rgb", value: RgbArrayType | RgbObjectType | RgbaArrayType): Color
Parameters
- type: "rgb"
- value: RgbArrayType | RgbObjectType | RgbaArrayType
Returns Color
- Defined in tools/ColorConverter.ts:122
from(type: "hsl", value: HslArrayType | HslObjectType | HslaArrayType): Color
Parameters
- type: "hsl"
- value: HslArrayType | HslObjectType | HslaArrayType
Returns Color
- Defined in tools/ColorConverter.ts:123