colord - npm Package Compare versions

Comparing version 2.3.0 to 2.4.0

CHANGELOG.md

@@ -0,1 +1,5 @@
+### 2.4.0
+
+- New plugin: Color harmonies generator ❤️ [@EricRovell](https://github.com/EricRovell)
+
 ### 2.3.0
@@ -2,0 +6,0 @@

package.json

 {
   "name": "colord",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "👑 A tiny yet powerful tool for high-performance color manipulations and conversions",
@@ -22,3 +22,4 @@ "keywords": [
     "cmyk",
-    "mix"
+    "mix",
+    "harmonies"
   ],
@@ -47,2 +48,7 @@ "repository": "omgovich/colord",
     },
+    "./plugins/harmonies": {
+      "import": "./plugins/harmonies.mjs",
+      "require": "./plugins/harmonies.js",
+      "default": "./plugins/harmonies.mjs"
+    },
     "./plugins/hwb": {
@@ -156,2 +162,6 @@ "import": "./plugins/hwb.mjs",
     {
+      "path": "dist/plugins/harmonies.mjs",
+      "limit": "0.5 KB"
+    },
+    {
       "path": "dist/plugins/hwb.mjs",
@@ -158,0 +168,0 @@ "limit": "1 KB"

README.md

@@ -504,2 +504,24 @@ <div align="center">
 
+<details>
+  <summary><b><code>.harmonies(type = "complementary")</code></b> (<b>harmonies</b> plugin)</summary>
+
+Provides functionality to generate [harmony colors](<https://en.wikipedia.org/wiki/Harmony_(color)>). Returns an array of `Colord` instances.
+
+```js
+import { colord, extends } from "colord";
+import harmoniesPlugin from "colord/plugins/harmonies";
+
+extend([harmoniesPlugin]);
+
+const color = colord("#ff0000");
+color.harmonies("analogous").map((c) => c.toHex()); // ["#ff0080", "#ff0000", "#ff8000"]
+color.harmonies("complementary").map((c) => c.toHex()); // ["#ff0000", "#00ffff"]
+color.harmonies("rectangle").map((c) => c.toHex()); // ["#ff0000", "#ffff00", "#00ffff", "#0000ff"]
+color.harmonies("split-complementary").map((c) => c.toHex()); // ["#ff0000", "#00ff80", "#0080ff"]
+color.harmonies("tetradic").map((c) => c.toHex()); // ["#ff0000", "#80ff00", "#00ffff", "#8000ff"]
+color.harmonies("triadic").map((c) => c.toHex()); // ["#ff0000", "#00ff00", "#0000ff"]
+```
+
+</details>
+
 ### Color analysis
@@ -710,2 +732,24 @@
 <details>
+  <summary><b><code>harmonies</code> (Color harmonies)</b> <i>0.15 KB</i></summary>
+
+Provides functionality to generate [harmony colors](<https://en.wikipedia.org/wiki/Harmony_(color)>).
+
+```js
+import { colord, extends } from "colord";
+import harmonies from "colord/plugins/harmonies";
+
+extend([harmonies]);
+
+const color = colord("#ff0000");
+color.harmonies("analogous").map((c) => c.toHex()); // ["#ff0080", "#ff0000", "#ff8000"]
+color.harmonies("complementary").map((c) => c.toHex()); // ["#ff0000", "#00ffff"]
+color.harmonies("rectangle").map((c) => c.toHex()); // ["#ff0000", "#ffff00", "#00ffff", "#0000ff"]
+color.harmonies("split-complementary").map((c) => c.toHex()); // ["#ff0000", "#00ff80", "#0080ff"]
+color.harmonies("tetradic").map((c) => c.toHex()); // ["#ff0000", "#80ff00", "#00ffff", "#8000ff"]
+color.harmonies("triadic").map((c) => c.toHex()); // ["#ff0000", "#00ff00", "#0000ff"]
+```
+
+</details>
+
+<details>
   <summary><b><code>hwb</code> (HWB color model)</b> <i>0.8 KB</i></summary>
@@ -712,0 +756,0 @@

No alert changes

Improved metrics

Total package byte prevSize

100107

increased by3.6%

Number of package files

41

increased by7.89%

Lines of code

587

increased by3.53%

Number of lines in readme file

915

increased by5.05%

No dependency changes