color-bits 1.0.5 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/build/format.d.ts +4 -1
- package/build/format.js +12 -2
- package/build/format.js.map +1 -1
- package/package.json +17 -11
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<b>High-performance color library</b>
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
|
-
This library represents RGBA colors as a single `int32` number and avoids allocating memory as much as possible while parsing, handling, and formatting colors, to provide the best possible memory and CPU efficiency.
|
|
9
|
+
This library represents RGBA colors as a single `int32` number and avoids allocating memory as much as possible while parsing, handling, and formatting colors, to provide the best possible memory and CPU efficiency. For a full technical overview, [read the blog post](https://romgrk.com/posts/color-bits/).
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
12
12
|
<a href="#-benchmarks">Benchmarks</a> •
|
|
@@ -38,7 +38,9 @@ pnpm install color-bits
|
|
|
38
38
|
|
|
39
39
|
### 📑 Technical details
|
|
40
40
|
|
|
41
|
-
Due to the compact representation, `color-bits` preserves **at most 8 bits of precision for each channel**, so an operation like `
|
|
41
|
+
Due to the compact representation, `color-bits` preserves **at most 8 bits of precision for each channel**, so an operation like `lighten(color, 0.000001)` would simply return the same color with no modification.
|
|
42
|
+
|
|
43
|
+
For performance reasons, the color representation is `int32`, not `uint32`. It is expected if you see negative numbers when you print the raw color value. Use the formatting functions to transform the color representation back into a usable format.
|
|
42
44
|
|
|
43
45
|
`color-bits` supports the full **CSS Color Module Level 4** color spaces **in absolute representations only**, so:
|
|
44
46
|
- Yes: `oklab(59.69% 0.1007 0.1191)`
|
|
@@ -46,8 +48,6 @@ Due to the compact representation, `color-bits` preserves **at most 8 bits of pr
|
|
|
46
48
|
|
|
47
49
|
When parsing and converting non-sRGB color spaces, `color-bits` behaves the same as browsers do, which differs from the formal CSS spec! In technical terms: non-sRGB color spaces with a wider gamut are converted using clipping rather than gamut-mapping.
|
|
48
50
|
|
|
49
|
-
For performance reasons, the representation is `int32`, not `uint32`. It is expected if you see negative numbers when you print the color value.
|
|
50
|
-
|
|
51
51
|
Every function is tree-shakeable, so the bundle size cost should be from 1.5kb to 3kb, depending on which functions you use.
|
|
52
52
|
|
|
53
53
|
### 📚 Documentation
|
package/build/format.d.ts
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
import type { Color } from './core';
|
|
2
2
|
/** Format to a #RRGGBBAA string */
|
|
3
|
-
export declare
|
|
3
|
+
export declare const format: typeof formatHEXA;
|
|
4
|
+
/** Format to a #RRGGBBAA string */
|
|
5
|
+
export declare function formatHEXA(color: Color): string;
|
|
6
|
+
export declare function formatHEX(color: Color): string;
|
|
4
7
|
export declare function formatRGBA(color: Color): string;
|
|
5
8
|
export declare function toRGBA(color: Color): {
|
|
6
9
|
r: number;
|
package/build/format.js
CHANGED
|
@@ -23,7 +23,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
23
23
|
return result;
|
|
24
24
|
};
|
|
25
25
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
26
|
-
exports.format =
|
|
26
|
+
exports.format = void 0;
|
|
27
|
+
exports.formatHEXA = formatHEXA;
|
|
28
|
+
exports.formatHEX = formatHEX;
|
|
27
29
|
exports.formatRGBA = formatRGBA;
|
|
28
30
|
exports.toRGBA = toRGBA;
|
|
29
31
|
exports.formatHSLA = formatHSLA;
|
|
@@ -41,13 +43,21 @@ const buffer = [0, 0, 0];
|
|
|
41
43
|
const FORMAT_HEX = Array.from({ length: 256 })
|
|
42
44
|
.map((_, byte) => byte.toString(16).padStart(2, '0'));
|
|
43
45
|
/** Format to a #RRGGBBAA string */
|
|
44
|
-
|
|
46
|
+
exports.format = formatHEXA;
|
|
47
|
+
/** Format to a #RRGGBBAA string */
|
|
48
|
+
function formatHEXA(color) {
|
|
45
49
|
return ('#' +
|
|
46
50
|
FORMAT_HEX[getRed(color)] +
|
|
47
51
|
FORMAT_HEX[getGreen(color)] +
|
|
48
52
|
FORMAT_HEX[getBlue(color)] +
|
|
49
53
|
FORMAT_HEX[getAlpha(color)]);
|
|
50
54
|
}
|
|
55
|
+
function formatHEX(color) {
|
|
56
|
+
return ('#' +
|
|
57
|
+
FORMAT_HEX[getRed(color)] +
|
|
58
|
+
FORMAT_HEX[getGreen(color)] +
|
|
59
|
+
FORMAT_HEX[getBlue(color)]);
|
|
60
|
+
}
|
|
51
61
|
function formatRGBA(color) {
|
|
52
62
|
return `rgba(${getRed(color)} ${getGreen(color)} ${getBlue(color)} / ${getAlpha(color) / 255})`;
|
|
53
63
|
}
|
package/build/format.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAoBA,gCAQC;AAED,8BAOC;AAED,gCAEC;AAED,wBAOC;AAED,gCAYC;AAED,wBAYC;AAED,gCAYC;AAED,wBAYC;AAzGD,6CAA8B;AAE9B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;AAEpD,mCAAmC;AACnC,MAAM,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;AAExB;;;GAGG;AACH,MAAM,UAAU,GACd,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;KACxB,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAA;AAEzD,mCAAmC;AACtB,QAAA,MAAM,GAAG,UAAU,CAAC;AAEjC,mCAAmC;AACnC,SAAgB,UAAU,CAAC,KAAY;IACrC,OAAO,CACL,GAAG;QACH,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzB,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3B,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC1B,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAC5B,CAAA;AACH,CAAC;AAED,SAAgB,SAAS,CAAC,KAAY;IACpC,OAAO,CACL,GAAG;QACH,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACzB,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC3B,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC3B,CAAA;AACH,CAAC;AAED,SAAgB,UAAU,CAAC,KAAY;IACrC,OAAO,QAAQ,MAAM,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAA;AACjG,CAAC;AAED,SAAgB,MAAM,CAAC,KAAY;IACjC,OAAO;QACL,CAAC,EAAE,MAAM,CAAC,KAAK,CAAC;QAChB,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC;QAClB,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC;QACjB,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC;KACnB,CAAA;AACH,CAAC;AAED,SAAgB,UAAU,CAAC,KAAY;IACrC,QAAQ,CACN,MAAM,CAAC,KAAK,CAAC,EACb,QAAQ,CAAC,KAAK,CAAC,EACf,OAAO,CAAC,KAAK,CAAC,CACf,CAAA;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAE/B,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAA;AACxC,CAAC;AAED,SAAgB,MAAM,CAAC,KAAY;IACjC,QAAQ,CACN,MAAM,CAAC,KAAK,CAAC,EACb,QAAQ,CAAC,KAAK,CAAC,EACf,OAAO,CAAC,KAAK,CAAC,CACf,CAAA;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAE/B,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;AACvB,CAAC;AAED,SAAgB,UAAU,CAAC,KAAY;IACrC,QAAQ,CACN,MAAM,CAAC,KAAK,CAAC,EACb,QAAQ,CAAC,KAAK,CAAC,EACf,OAAO,CAAC,KAAK,CAAC,CACf,CAAA;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAE/B,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAA;AACxC,CAAC;AAED,SAAgB,MAAM,CAAC,KAAY;IACjC,QAAQ,CACN,MAAM,CAAC,KAAK,CAAC,EACb,QAAQ,CAAC,KAAK,CAAC,EACf,OAAO,CAAC,KAAK,CAAC,CACf,CAAA;IACD,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;IACnB,MAAM,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,GAAG,CAAA;IAE/B,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAA;AACvB,CAAC;AAED,uBAAuB;AAEvB,gFAAgF;AAChF,SAAS,QAAQ,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;IAC/C,CAAC,IAAI,GAAG,CAAC;IACT,CAAC,IAAI,GAAG,CAAC;IACT,CAAC,IAAI,GAAG,CAAC;IAET,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC5B,MAAM,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAChC,MAAM,CAAC,GAAG,CAAC;QACT,CAAC,CAAC,CAAC,KAAK,CAAC;YACP,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;YACb,CAAC,CAAC,CAAC,KAAK,CAAC;gBACT,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;gBACjB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC;QACnB,CAAC,CAAC,CAAC,CAAC;IAEN,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;IAC9C,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;IAChF,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AACrC,CAAC;AAED,+CAA+C;AAC/C,SAAS,QAAQ,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;IAC/C,CAAC,IAAI,GAAG,CAAA;IACR,CAAC,IAAI,GAAG,CAAA;IACR,CAAC,IAAI,GAAG,CAAA;IAER,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC3B,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;IAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,CAAA;IAEnB,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACZ,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACb,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;QACb,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;QACjB,OAAM;IACR,CAAC;IAED,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAExC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IACjC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;IACb,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;AACnB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,8 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "color-bits",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"main": "./build/index.js",
|
|
5
5
|
"sideEffects": false,
|
|
6
|
+
"homepage": "https://github.com/romgrk/color-bits",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/romgrk/color-bits.git"
|
|
10
|
+
},
|
|
11
|
+
"scripts": {
|
|
12
|
+
"prepack": "pnpm run build && npmignore --auto",
|
|
13
|
+
"build": "tsc",
|
|
14
|
+
"start": "tsc --watch",
|
|
15
|
+
"docs": "pnpm run docs:core && pnpm run docs:string",
|
|
16
|
+
"docs:core": "typedoc --readme none --plugin typedoc-plugin-markdown --out ./docs ./src/index.ts",
|
|
17
|
+
"docs:string": "typedoc --readme none --plugin typedoc-plugin-markdown --out ./docs/string ./src/string.ts",
|
|
18
|
+
"benchmark": "tsx ./benchmarks/index.ts",
|
|
19
|
+
"test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --watch"
|
|
20
|
+
},
|
|
6
21
|
"exports": {
|
|
7
22
|
".": "./build/index.js",
|
|
8
23
|
"./*": "./build/*",
|
|
@@ -44,14 +59,5 @@
|
|
|
44
59
|
"typedoc": "^0.26.6",
|
|
45
60
|
"typedoc-plugin-markdown": "^4.2.6",
|
|
46
61
|
"typescript": "^5.5.4"
|
|
47
|
-
},
|
|
48
|
-
"scripts": {
|
|
49
|
-
"build": "tsc",
|
|
50
|
-
"start": "tsc --watch",
|
|
51
|
-
"docs": "pnpm run docs:core && pnpm run docs:string",
|
|
52
|
-
"docs:core": "typedoc --readme none --plugin typedoc-plugin-markdown --out ./docs ./src/index.ts",
|
|
53
|
-
"docs:string": "typedoc --readme none --plugin typedoc-plugin-markdown --out ./docs/string ./src/string.ts",
|
|
54
|
-
"benchmark": "tsx ./benchmarks/index.ts",
|
|
55
|
-
"test": "NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest --watch"
|
|
56
62
|
}
|
|
57
|
-
}
|
|
63
|
+
}
|