@thi.ng/color 5.1.11 → 5.2.1

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-08-01T14:53:59Z
+- **Last updated**: 2022-09-27T16:23:13Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [5.2.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.2.0) (2022-09-21)
+
+#### 🚀 Features
+
+- add WCAG2 contrast() fn ([a132107](https://github.com/thi-ng/umbrella/commit/a132107))
+
 ## [5.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/color@5.1.0) (2022-06-09)
 
 #### 🚀 Features

package/README.md

@@ -1,6 +1,6 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![color](https://media.thi.ng/umbrella/banners/thing-color.svg?f089ad05)
+# ![color](https://media.thi.ng/umbrella/banners-20220914/thing-color.svg?a647740f)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/color.svg)](https://www.npmjs.com/package/@thi.ng/color)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/color.svg)
@@ -22,9 +22,9 @@ For the Clojure version, please visit: [thi.ng/color-clj](https://thi.ng/color-c
     - [Multi-stop gradients in any color space](#multi-stop-gradients-in-any-color-space)
     - [Cosine gradients](#cosine-gradients)
   - [RGB color transformations](#rgb-color-transformations)
-  - [Status](#status)
-  - [Support packages](#support-packages)
-  - [Related packages](#related-packages)
+- [Status](#status)
+- [Support packages](#support-packages)
+- [Related packages](#related-packages)
 - [Installation](#installation)
 - [Dependencies](#dependencies)
 - [Usage examples](#usage-examples)
@@ -563,17 +563,17 @@ including parametric preset transforms:
 Transformation matrices can be combined using matrix multiplication /
 concatenation (see `concat()`) for more efficient application.
 
-### Status
+## Status
 
 **STABLE** - used in production
 
 [Search or submit any issues for this package](https://github.com/thi-ng/umbrella/issues?q=%5Bcolor%5D+in%3Atitle)
 
-### Support packages
+## Support packages
 
-- [@thi.ng/color-palettes](https://github.com/thi-ng/umbrella/tree/develop/packages/color-palettes) - Collection of 176 image based color palettes
+- [@thi.ng/color-palettes](https://github.com/thi-ng/umbrella/tree/develop/packages/color-palettes) - Collection of 190+ image based color palettes
 
-### Related packages
+## Related packages
 
 - [@thi.ng/pixel](https://github.com/thi-ng/umbrella/tree/develop/packages/pixel) - Typedarray integer & float pixel buffers w/ customizable formats, blitting, drawing, convolution
 - [@thi.ng/vectors](https://github.com/thi-ng/umbrella/tree/develop/packages/vectors) - Optimized 2d/3d/4d and arbitrary length vector operations
@@ -601,7 +601,7 @@ node --experimental-repl-await
 > const color = await import("@thi.ng/color");
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 17.47 KB
+Package sizes (gzipped, pre-treeshake): ESM: 17.50 KB
 
 ## Dependencies
 

package/contrast.d.ts

@@ -0,0 +1,16 @@
+import type { MaybeColor } from "./api.js";
+/**
+ * Computes the WCAG 2.0 contrast ratio of the two given colors (order is
+ * irrelevant). Contrast ratios can range from 1 to 21.
+ *
+ * @remarks
+ * For accessibility guideline conformance, the visual presentation of text must
+ * have a minimum contrast ratio of at least 4.5 (with some exceptions).
+ *
+ * Reference: https://www.w3.org/TR/WCAG20/#contrast-ratiodef
+ *
+ * @param a
+ * @param b
+ */
+export declare const contrast: (a: MaybeColor, b: MaybeColor) => number;
+//# sourceMappingURL=contrast.d.ts.map

package/contrast.js

@@ -0,0 +1,20 @@
+import { luminanceRgb } from "./luminance-rgb.js";
+import { rgb } from "./rgb/rgb.js";
+/**
+ * Computes the WCAG 2.0 contrast ratio of the two given colors (order is
+ * irrelevant). Contrast ratios can range from 1 to 21.
+ *
+ * @remarks
+ * For accessibility guideline conformance, the visual presentation of text must
+ * have a minimum contrast ratio of at least 4.5 (with some exceptions).
+ *
+ * Reference: https://www.w3.org/TR/WCAG20/#contrast-ratiodef
+ *
+ * @param a
+ * @param b
+ */
+export const contrast = (a, b) => {
+    const lumA = luminanceRgb(rgb(a)) + 0.05;
+    const lumB = luminanceRgb(rgb(b)) + 0.05;
+    return lumA > lumB ? lumA / lumB : lumB / lumA;
+};

package/index.d.ts

@@ -5,6 +5,7 @@ export * from "./api/names.js";
 export * from "./api/ranges.js";
 export * from "./api/system.js";
 export * from "./color.js";
+export * from "./contrast.js";
 export * from "./convert.js";
 export * from "./defcolor.js";
 export * from "./css/css.js";

package/index.js

@@ -5,6 +5,7 @@ export * from "./api/names.js";
 export * from "./api/ranges.js";
 export * from "./api/system.js";
 export * from "./color.js";
+export * from "./contrast.js";
 export * from "./convert.js";
 export * from "./defcolor.js";
 export * from "./css/css.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color",
-  "version": "5.1.11",
+  "version": "5.2.1",
   "description": "Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets",
   "type": "module",
   "module": "./index.js",
@@ -36,27 +36,27 @@
     "tool:swatches": "tools:node-esm tools/index.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.4.1",
-    "@thi.ng/arrays": "^2.3.5",
-    "@thi.ng/binary": "^3.3.4",
-    "@thi.ng/checks": "^3.2.4",
-    "@thi.ng/compare": "^2.1.11",
-    "@thi.ng/compose": "^2.1.12",
-    "@thi.ng/defmulti": "^2.1.13",
-    "@thi.ng/errors": "^2.1.10",
-    "@thi.ng/math": "^5.3.7",
-    "@thi.ng/random": "^3.3.7",
-    "@thi.ng/strings": "^3.3.11",
-    "@thi.ng/transducers": "^8.3.13",
-    "@thi.ng/vectors": "^7.5.14"
+    "@thi.ng/api": "^8.4.2",
+    "@thi.ng/arrays": "^2.3.6",
+    "@thi.ng/binary": "^3.3.5",
+    "@thi.ng/checks": "^3.2.5",
+    "@thi.ng/compare": "^2.1.12",
+    "@thi.ng/compose": "^2.1.13",
+    "@thi.ng/defmulti": "^2.1.14",
+    "@thi.ng/errors": "^2.2.0",
+    "@thi.ng/math": "^5.3.9",
+    "@thi.ng/random": "^3.3.8",
+    "@thi.ng/strings": "^3.3.12",
+    "@thi.ng/transducers": "^8.3.15",
+    "@thi.ng/vectors": "^7.5.16"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.25.0",
-    "@thi.ng/testament": "^0.2.12",
+    "@microsoft/api-extractor": "^7.31.1",
+    "@thi.ng/testament": "^0.3.0",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
     "typedoc": "^0.22.17",
-    "typescript": "^4.7.4"
+    "typescript": "^4.8.3"
   },
   "keywords": [
     "color",
@@ -162,6 +162,9 @@
     "./color": {
       "default": "./color.js"
     },
+    "./contrast": {
+      "default": "./contrast.js"
+    },
     "./convert": {
       "default": "./convert.js"
     },
@@ -421,5 +424,5 @@
       "vectors"
     ]
   },
-  "gitHead": "be8423e2019e95c14a096260a93b9762dde0c768\n"
+  "gitHead": "f4c59114f2d2dfafa9014626038a9ec5242b0606\n"
 }