@radiatingstar/color-utilities NPM

Color utilities

Collection of useful methods for colors parsing, validation, transformations and calculations. Exposed as a class, so can be used as a stand-alone, or inside Angular apps.

Install and use

npm install @radiatingstar/color-utilities

Use in a JavaScript or TypeScript project:

// TypeScript, JavaScript module
import {ColorUtilities} from '@radiatingstar/color-utilities'

// Node, Browserify
const ColorUtilities = require('@radiatingstar/color-utilities')

// Create using a `new` keyword or with a factory.
const colorUtils = new ColorUtilities()
const colorUtilsFromFactory = ColorUtilities.create()

Library is compatible with the Angular 2 dependency injection system. Provide it as a dependency in a Component or NgModule decorator.

@Component({
  ...
  providers: [ColorUtilities, ...]
})
class MyComponent {
  consturctor(private colorUtilities: ColorUtilities) {}
}

Features

Parsers

Parse any color

#parseColor(color: anyColor): colorValues

Transforms RGB, HSL or hex color into an array of RGB values. A generic variant of specific parsers dedicated for hex and RGB colors.

Parameters

color - A color in RGB, HSL or hex format to be parsed.

Returns

An array representation of the provided number. Throws if an invalid color was used (use validators methods id unsure if the value will always be correct).

Example

colorUtil.parseColor('#FFAA500') // => [255, 165, 0]
colorUtil.parseColor('#fff') // => [255, 255, 255]
colorUtil.parseColor('rgb(255, 165, 0)') // => [255, 165, 0]
colorUtil.parseColor('rgb(255, 255, 255)') // => [255, 255, 255]
colorUtil.parseColor('hsl(0, 100%, 100%)') // => [255, 255, 255]

Parse a hexadecimal color

#parseHexColor(color: hexColor): colorValues

Transforms a hexadecimal color into an array of RGB values in base-10.

Parameters

color - A hexadecimal color (eg. '#FFA500'). Shorthand notation ('#FFF') and small caps are also supported.

Returns

An array representation of the provided number. Throws if an invalid hex was used (use validators methods id unsure if the value will always be correct).

Examples

colorUtil.parseHexColor('#FFAA500') // => [255, 165, 0]
colorUtil.parseHexColor('#fff') // => [255, 255, 255]

Parse an RGB color

#parseRgbColor(color: RGBColor): colorValues

Transforms an RGB color into an array of RGB values.

Parameters

color - An RGB color (eg. 'rgb(255, 265, 0)').

Returns

An array representation of the provided number. Throws if an invalid RGB format was used (use validators methods id unsure if the value will always be correct).

Examples

colorUtil.parseHexColor('rgb(255, 165, 0)') // => [255, 165, 0]
colorUtil.parseHexColor('rgb(255, 255, 255)') // => [255, 255, 255]

Parse an HSL color

#parseHslColor(color: HSLColor): colorValues

Transforms an HSL color into an array of RGB values.

Parameters

color - An HSL color (eg. 'hsl(123, 45%, 0%)').

Returns

An array representation of the provided number. Throws if an invalid HSL format was used (use validators methods id unsure if the value will always be correct).

Examples

colorUtil.parseHslColor('hsl(123, 100%, 100%)') // => [255, 255, 255]

Validators

Validate a color

#isValidColor(potentialColor?: anyColor): boolean

Checks if the provided color is a valid hexadecimal color, an RGB color or an HSL color. Uses specific validators internally, so the edge cases from them applies here.

Parameters

color - A color to be validated.

Returns

A boolean indicating validity of the color. For clarity sake: true means the color is valid.

Examples

colorUtil.isValidColor('#FFA500') // => true 
colorUtil.isValidColor('rgb(255, 165, 0)') // => true
colorUtil.isValidColor('hsl(200, 100%, 50%)') // => true
colorUtil.isValidColor('#QWERTY') // => false 
colorUtil.isValidColor('#123456789') // => false
colorUtil.isValidColor(null) // => false

Validate a hexadecimal color

#isValidHexColor(potentialHexColor?: hexColor): boolean

Checks if the provided color is a valid hexadecimal color.

Parameters

color - A hexadecimal color (eg. '#FFA500'). Shorthand notation ('#FFF') and small caps are also supported.

Returns

A boolean indicating validity of the color. For clarity sake: true means the color is valid.

Examples

colorUtil.isValidHexColor('#FFA500') // => true 
colorUtil.isValidHexColor('#fff') // => true
colorUtil.isValidHexColor('#QWERTY') // => false 
colorUtil.isValidHexColor('#123456789') // => false
colorUtil.isValidHexColor(null) // => false

Validate an RGB color

#isValidRgbColor(potentialRgbColor?: RGBColor): boolean

Checks if the provided color is a valid RGB color.

Parameters

color - An RGB color (eg. 'rgb(255, 165, 0)').

Returns

A boolean indicating validity of the color. For clarity sake: true means the color is valid.

Examples

colorUtil.isValidRgbColor('rgb(0, 0, 0)') // => true 
colorUtil.isValidRgbColor('rgb(255, 165, 0') // => true
colorUtil.isValidRgbColor('xrgb(255, 255, 255') // => false 
colorUtil.isValidRgbColor('rgb(300, 300, 300') // => false
colorUtil.isValidRgbColor(null) // => false

Validate an HSL color

#isValidHslColor(potentialHslColor?: HSLColor): boolean

Checks if the provided color is a valid HSL color.

Parameters

color - An HSL color (eg. 'hsl(300, 50%, 50%)').

Returns

A boolean indicating validity of the color. For clarity sake: true means the color is valid.

Examples

colorUtil.isValidHslColor('hsl(123, 100%, 10%)') // => true 
colorUtil.isValidHslColor('hsl(255, 1%, 40%') // => true
colorUtil.isValidHslColor('xhsl(255, 255, 255') // => false 
colorUtil.isValidHslColor('hsl(400, 50%, 50%') // => false
colorUtil.isValidHslColor('hsl(100, 50, 50') // => false
colorUtil.isValidHslColor(null) // => false

Analyzers

Get the hexadecimal color's parts

#splitHexColor(color: hexColor): hexColorValues

Splits the hexadecimal color into an array of it's hexadecimal RGB values.

Parameters

color - A hexadecimal color (eg. '#FFA500'). Shorthand notation ('#FFF') and small caps are also supported. The return value is always normalized to uppercase two letters/numbers long values.

Returns

The result of this method is a 3 items long array of hexadecimal RGB values.

Examples

colorUtil.splitHexColor('#FFA500') // => ['FF', 'A5', '00']
colorUtil.splitHexColor('#fff') // => ['FF', 'FF', 'FF']

Get the RGB color's parts

#splitRgbColor(color: RGBColor): colorValues

Splits the RGB color into an array of it's RGB values.

Parameters

color - An RGB color (eg. 'rgb(255, 165, 0)').

Returns

The result of this method is a 3 items long array of RGB values.

Examples

colorUtil.splitRgbColor('rgb(255, 165, 0)') // => [255, 165, 0]
colorUtil.splitRgbColor('rgb(255, 255, 255)') // => [255, 255, 255]

Get the HSL color's parts

#splitHslColor(color: HSLColor): colorValues

Splits the HSL color into an array of it's RGB values.

Parameters

color - An HSL color (eg. 'hsl(123, 10%, 50%)').

Returns

The result of this method is a 3 items long array of RGB values.

Examples

colorUtil.splitHslColor('hsl(39, 100%, 50%)') // => [255, 166, 0]
colorUtil.splitHslColor('hsl(0, 100%, 100%)') // => [255, 255, 255]

Normalizers

Normalize a hexadecimal color value

#normalizeHexColor(hexColor: hexColor): hexColor

Transforms a valid hex color into a uniform shape: 6 uppercased characters.

Parameters

color - A valid hex color that might be written in a shorthand notation or in lower case. As a bonus, this method considers the colors without initial '#' as semi-valid and adds the missing sign (validation still reports it's not a valid color).

Returns

A valid, 6 characters long (7 with '#') string of uppercased letters and numbers.

Examples

colorUtil.normalizeHexColor('#fff') // => '#FFFFFF'

Normalize an RGB color value

#normalizeRgbColor(rgbColor: RGBColor): RGBColor

Transforms a valid RGB color into a uniform shape (lowercased with consistent spacing).

Parameters

color - A valid RGB color.

Returns

A valid, lowercased color string with consistent spacing.

Examples

colorUtil.normalizeRgbColor('  RGB (  123,      123,1  )') // => 'rgb(123, 123, 1)

Normalize an HSL color value

#normalizeHslColor(hslColor: HSLColor): HSLColor

Transforms a valid HSL color into a uniform shape (lowercased with consistent spacing).

Parameters

color - A valid HSL color.

Returns

A valid, lowercased color string with consistent spacing.

Examples

colorUtil.normalizeHslColor('  HSL (  123,      100%,1%  )') // => 'hsl(123, 100%, 1%)

Utilities

Calculate luminance of a color

#calculateLuminanceOf(color: anyColor): number

Calculates the relative luminance of a color, as defined in the W3C Specification.

Parameters

color - A valid color.

Returns

A number representing the relative luminance in 0-1 range.

Examples

colorUtil.calculateLuminanceOf('#FFFFFF') // => 1
colorUtil.calculateLuminanceOf('rgb(255, 255, 255)') // => 1
colorUtil.calculateLuminanceOf('hsl(100, 100%, 100%)') // => 1
colorUtil.calculateLuminanceOf('#000000') // => 0
colorUtil.calculateLuminanceOf('#FFA500') // => 0.48170267036309633

Calculate contrast between two colors

#calculateContrastRatio(color1: anyColor, color2: anyColor): number

Calculates a contrast ratio between two colors, as defined in the W3C Specification.

Parameters

color1 - A valid color. color2 - A valid color.

Returns

A contrast between the provided colors. The value is in range 1-21.

Examples

colorUtil.calculateContrastRatio('#FFFFFF', '#000000') // => 21
colorUtil.calculateContrastRatio('rgb(255, 255, 255)', 'rgb(0, 0, 0)') // => 21
colorUtil.calculateContrastRatio('#000000', '#000000') // => 1
colorUtil.calculateContrastRatio('#FFA500', '#000000') // => 11
colorUtil.calculateContrastRatio('hsl(100, 100%, 100%)', '#000000') // => 21

License

MIT

colors contrast utilities

@everything-registry/sub-chunk-754 @infinitebrahmanuniverse/nolb-_rad @zalastax/nolb-_rad

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago