feat(color): add hue() function

thi-ng · Feb 9, 2023 · c5c3dd5 · c5c3dd5
1 parent 196b41f
commit c5c3dd5
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/packages/color/src/hue.ts b/packages/color/src/hue.ts
@@ -0,0 +1,25 @@
+import { DEFAULT, defmulti } from "@thi.ng/defmulti/defmulti";
+import type { TypedColor } from "./api.js";
+import { hsv } from "./hsv/hsv.js";
+import { __dispatch0 } from "./internal/dispatch.js";
+
+/**
+ * Returns the (normalized) hue of given color.
+ *
+ * @remarks
+ * Since LCH uses different hue values than the more familiar HSV/HSL color
+ * wheel, LCH colors will be first converted to HSV to ensure uniform results.
+ */
+export const hue = defmulti<TypedColor<any>, number>(
+	__dispatch0,
+	{
+		hcy: "hsv",
+		hsi: "hsv",
+		hsl: "hsv",
+	},
+	{
+		[DEFAULT]: (col: TypedColor<any>) => hsv(col)[0],
+
+		hsv: (col) => col[0],
+	}
+);
diff --git a/packages/color/src/index.ts b/packages/color/src/index.ts
@@ -58,6 +58,7 @@ export * from "./color-range.js";
 export * from "./cosine-gradients.js";
 export * from "./distance.js";
 export * from "./gradients.js";
+export * from "./hue.js";
 export * from "./invert.js";
 export * from "./is-black.js";
 export * from "./is-gamut.js";