@sardine/colour 2.4.0 → 3.0.0

package/dist/assertions.d.ts

@@ -2,7 +2,7 @@ import type { NamedCSSColour } from "./types";
 /**
  * Determines whether a string represents a valid CSS RGB or RGBA colour value.
  *
- * Captures the folowing CSS RGB formats:
+ * Captures the following CSS RGB formats:
  * - `rgb(0,0,0)`
  * - `rgba(0, 0, 0, 0.4)`
  * - `rgba(0,0,0,50%)`
@@ -10,6 +10,9 @@ import type { NamedCSSColour } from "./types";
  * - `rgba(0 0 0 / 0.4)`
  * - `rgb(0 0 0 / 0.5)`
  * - `rgb(0 0 0 / 50%)`
+ * - `rgb(50%, 25%, 100%)`
+ * - `rgba(50%, 25%, 100%, 0.8)`
+ * - `rgba(50%, 25%, 100%, 80%)`
  *
  * @param {string} colour - The string to test.
  * @returns {boolean} `true` if the string represents a valid CSS RGB or RGBA colour value, `false` otherwise.

package/dist/convertCSSRGBtoHex.d.ts

@@ -6,6 +6,9 @@
  * - `rgba(0,0,0,0.4)`
  * - `rgb(0 0 0)`
  * - `rgba(0 0 0 / 0.4)`
+ * - `rgb(50%, 25%, 100%)`
+ * - `rgba(50%, 25%, 100%, 0.8)`
+ * - `rgba(50%, 25%, 100%, 80%)`
  *
  * @returns {string} - An hexadecimal string
  */

package/dist/convertCSSRGBtoRGB.d.ts

@@ -1,4 +1,13 @@
 import type { RGBColour } from "./types";
+/**
+ * Converts a CSS RGB/Alpha value to its numeric equivalent
+ * @param value - The value string (e.g., "50%", "127", "0.5")
+ * @param isAlpha - Whether this is an alpha channel value
+ * @returns The numeric value
+ */
+export declare function convertCssValueToNumber(value: string, isAlpha?: boolean): number;
+export declare function convertCssRgbChannelValue(value?: string): number | undefined;
+export declare function convertCssAlphaChannelValue(value?: string): number | undefined;
 /**
  * Converts CSS RGB colour format into RGB colour object.
  * @param {string} colour - A CSS RGB colour in the format:
@@ -7,6 +16,9 @@ import type { RGBColour } from "./types";
  * - `rgba(0,0,0,0.4)`
  * - `rgb(0 0 0)`
  * - `rgba(0 0 0 / 0.4)`
+ * - `rgb(50%, 25%, 100%)`
+ * - `rgba(50%, 25%, 100%, 0.8)`
+ * - `rgba(50%, 25%, 100%, 80%)`
  *
  * @returns {RGBColour} - RGB colour object.
  */

package/dist/convertRGBtoHSV.d.ts

@@ -0,0 +1,16 @@
+import type { HSVColour } from "./types";
+/**
+ * Converts an RGB colour to HSV.
+ * Conversion formula is based on the RGB to HSV conversion algorithm:
+ * https://en.wikipedia.org/wiki/HSL_and_HSV#From_RGB
+ *
+ * https://www.niwa.nu/2013/05/math-behind-colorspace-conversions-rgb-hsl/
+ * - Hue (h) is calculated based on the maximum RGB value.
+ * - Saturation (s) is the chroma divided by the maximum RGB value.
+ * - Value (v) is the maximum RGB value.
+ * @param r Red channel (0-255)
+ * @param g Green channel (0-255)
+ * @param b Blue channel (0-255)
+ * @returns HSVColour object with h (hue), s (saturation), v (value)
+ */
+export declare function convertRGBtoHSV(r: number, g: number, b: number): HSVColour;

package/dist/getContrastRatio.d.ts

@@ -1,8 +1,9 @@
 import type { NamedCSSColour, WCAG } from "./types";
 /**
  * Calculates the contrast ratio between two colours.
- * @param colour1 The first colour
- * @param colour2 The second colour
+ * Accepts CSS RGB colours (including percentage values), named CSS colours, or hexadecimal colours.
+ * @param colour1 The first colour (e.g., `#ff0000`, `rgb(255,0,0)`, `rgb(100%, 0%, 0%)`, or `red`)
+ * @param colour2 The second colour (e.g., `#00ff00`, `rgb(0,255,0)`, `rgb(0%, 100%, 0%)`, or `lime`)
  * @param standard The standard to evaluate the contrast ratio against, defaults to WCAG2.1
  * @returns The contrast ratio between the two colours truncated to 3 decimal places
  */