UNPKG

@jstock/hexgen

Version:

A simple tool for generating hex code color ranges

github.com/jstock/hexgen

jstock/hexgen

102 lines (63 loc) • 2.52 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# hexgen A simple tool for generating hex code color ranges. This package is [hosted on npm](https://www.npmjs.com/package/@jstock/hexgen), so you can import into your project with your package manager of choice. # Usage ## generateHexColors() ```ts function generateHexColors(start, end, count, includeAlpha): string[]; ``` Generates a list of hex colors for a given range ### Parameters | Parameter | Type | Default value | Description | | -------------- | -------- | ------------- | -------------------------------------------------------------------- | | `start` | `string` | `undefined` | The starting color for the range | | `end` | `string` | `undefined` | The ending color for the range | | `count` | `number` | `undefined` | The number of colors to generate in between the start/end colors | | `includeAlpha` | `bool` | `false` | Whether to include alpha values for the hex codes, defaults to false | ### Returns `string`[] The hex color range ordered from start to end --- ## generateRandomHexColor() ```ts function generateRandomHexColor(includeAlpha): string; ``` Generates a random hex color string ### Parameters | Parameter | Type | Default value | Description | | -------------- | ------ | ------------- | ----------------------------------------------------- | | `includeAlpha` | `bool` | `false` | Whether to include the alpha value, defaults to false | ### Returns `string` The hex color string --- ## normalizeHexValue() ```ts function normalizeHexValue(hex): string; ``` Normalizes a hex value into a 6/8 digit representation ### Parameters | Parameter | Type | Description | | --------- | -------- | ------------- | | `hex` | `string` | The hex value | ### Returns `string` The normalized hex value, including a leading # --- ## parseHexColors() ```ts function parseHexColors(hex): object; ``` Parses a hex code string into its numeric color/alpha values ### Parameters | Parameter | Type | Description | | --------- | -------- | ------------------- | | `hex` | `string` | The hex code string | ### Returns `object` An object with the numeric color/alpha values | Name | Type | | ------- | -------- | | `alpha` | `number` | | `blue` | `number` | | `green` | `number` | | `red` | `number` |