hex-rgb

Convert HEX color to RGBA

Install

$ npm install hex-rgb

Usage

1import hexRgb from 'hex-rgb';
2
3hexRgb('4183c4');
4//=> {red: 65, green: 131, blue: 196, alpha: 1}
5
6hexRgb('#4183c4');
7//=> {red: 65, green: 131, blue: 196, alpha: 1}
8
9hexRgb('#fff');
10//=> {red: 255, green: 255, blue: 255, alpha: 1}
11
12hexRgb('#22222299');
13//=> {red: 34, green: 34, blue: 34, alpha: 0.6}
14
15hexRgb('#0006');
16//=> {red: 0, green: 0, blue: 0, alpha: 0.4}
17
18hexRgb('#cd2222cc');
19//=> {red: 205, green: 34, blue: 34, alpha: 0.8}
20
21hexRgb('#cd2222cc', {format: 'array'});
22//=> [205, 34, 34, 0.8]
23
24hexRgb('#cd2222cc', {format: 'css'});
25//=> 'rgb(205 34 34 / 80%)'
26
27hexRgb('#000', {format: 'css'});
28//=> 'rgb(0 0 0)'
29
30hexRgb('#22222299', {alpha: 1});
31//=> {red: 34, green: 34, blue: 34, alpha: 1}
32
33hexRgb('#fff', {alpha: 0.5});
34//=> {red: 255, green: 255, blue: 255, alpha: 0.5}

API

hexRgb(hex, options?)

hex

Type: string

The color in HEX format. Leading # is optional.

options

Type: object

format

Type: string
Values: 'object' | 'array' | 'css'
Defaults: 'object'

The RGB output format.

Note that when using the css format, the value of the alpha channel is rounded to two decimal places.

alpha

Type: number

Set the alpha of the color.

This overrides any existing alpha component in the Hex color string. For example, the 99 in #22222299.

The number must be in the range 0 to 1.

Related

See rgb-hex for the inverse.