@zag-js/color-utils 1.34.1 → 1.35.1

package/dist/types.d.mts

@@ -0,0 +1,87 @@
+type ColorHexFormat = "hex" | "hexa";
+type ColorFormat = "rgba" | "hsla" | "hsba";
+type ColorStringFormat = ColorHexFormat | ColorFormat | "rgb" | "hsl" | "hsb" | "css";
+type ColorChannel = "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "blue" | "alpha";
+interface Color2DAxes {
+    xChannel: ColorChannel;
+    yChannel: ColorChannel;
+}
+interface ColorAxes extends Color2DAxes {
+    zChannel: ColorChannel;
+}
+interface ColorChannelRange {
+    /** The minimum value of the color channel. */
+    minValue: number;
+    /** The maximum value of the color channel. */
+    maxValue: number;
+    /** The step value of the color channel, used when incrementing and decrementing. */
+    step: number;
+    /** The page step value of the color channel, used when incrementing and decrementing. */
+    pageSize: number;
+}
+interface ColorType {
+    /** Converts the color to the given color format, and returns a new Color object. */
+    toFormat(format: ColorFormat): ColorType;
+    /** Converts the color to a JSON object. */
+    toJSON(): Record<string, number>;
+    /** Converts the color to a string in the given format. Defaults to CSS format. */
+    toString(format?: ColorStringFormat): string;
+    /** Converts the color to hex, and returns an integer representation. */
+    toHexInt(): number;
+    /**
+     * Returns the numeric value for a given channel.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    getChannelValue(channel: ColorChannel): number;
+    /**
+     * Sets the numeric value for a given channel, and returns a new Color object.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    withChannelValue(channel: ColorChannel, value: number): ColorType;
+    /**
+     * Returns the formatted value for a given channel.
+     */
+    formatChannelValue(channel: ColorChannel, locale: string): string;
+    /**
+     * Returns the minimum, maximum, and step values for a given channel.
+     */
+    getChannelRange(channel: ColorChannel): ColorChannelRange;
+    /**
+     * Returns the color space, 'rgb', 'hsb' or 'hsl', for the current color.
+     */
+    getFormat(): ColorFormat;
+    /**
+     * Returns the color space axes, xChannel, yChannel, zChannel.
+     */
+    getColorAxes(xyChannels: Color2DAxes): ColorAxes;
+    /**
+     * Returns an array of the color channels within the current color space space.
+     */
+    getChannels(): [ColorChannel, ColorChannel, ColorChannel];
+    /**
+     * Returns a new Color object with the same values as the current color.
+     */
+    clone(): ColorType;
+    /**
+     * Whether the color is equal to another color.
+     */
+    isEqual(color: ColorType): boolean;
+    /**
+     * Increments the color channel by the given step size, and returns a new Color object.
+     */
+    incrementChannel(channel: ColorChannel, stepSize: number): ColorType;
+    /**
+     * Decrements the color channel by the given step size, and returns a new Color object.
+     */
+    decrementChannel(channel: ColorChannel, stepSize: number): ColorType;
+    /**
+     * Returns the color channel value as a percentage of the channel range.
+     */
+    getChannelValuePercent(channel: ColorChannel, value?: number): number;
+    /**
+     * Returns the color channel value for a given percentage of the channel range.
+     */
+    getChannelPercentValue(channel: ColorChannel, percent: number): number;
+}
+
+export type { Color2DAxes, ColorAxes, ColorChannel, ColorChannelRange, ColorFormat, ColorHexFormat, ColorStringFormat, ColorType };

package/dist/types.d.ts

@@ -0,0 +1,87 @@
+type ColorHexFormat = "hex" | "hexa";
+type ColorFormat = "rgba" | "hsla" | "hsba";
+type ColorStringFormat = ColorHexFormat | ColorFormat | "rgb" | "hsl" | "hsb" | "css";
+type ColorChannel = "hue" | "saturation" | "brightness" | "lightness" | "red" | "green" | "blue" | "alpha";
+interface Color2DAxes {
+    xChannel: ColorChannel;
+    yChannel: ColorChannel;
+}
+interface ColorAxes extends Color2DAxes {
+    zChannel: ColorChannel;
+}
+interface ColorChannelRange {
+    /** The minimum value of the color channel. */
+    minValue: number;
+    /** The maximum value of the color channel. */
+    maxValue: number;
+    /** The step value of the color channel, used when incrementing and decrementing. */
+    step: number;
+    /** The page step value of the color channel, used when incrementing and decrementing. */
+    pageSize: number;
+}
+interface ColorType {
+    /** Converts the color to the given color format, and returns a new Color object. */
+    toFormat(format: ColorFormat): ColorType;
+    /** Converts the color to a JSON object. */
+    toJSON(): Record<string, number>;
+    /** Converts the color to a string in the given format. Defaults to CSS format. */
+    toString(format?: ColorStringFormat): string;
+    /** Converts the color to hex, and returns an integer representation. */
+    toHexInt(): number;
+    /**
+     * Returns the numeric value for a given channel.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    getChannelValue(channel: ColorChannel): number;
+    /**
+     * Sets the numeric value for a given channel, and returns a new Color object.
+     * Throws an error if the channel is unsupported in the current color format.
+     */
+    withChannelValue(channel: ColorChannel, value: number): ColorType;
+    /**
+     * Returns the formatted value for a given channel.
+     */
+    formatChannelValue(channel: ColorChannel, locale: string): string;
+    /**
+     * Returns the minimum, maximum, and step values for a given channel.
+     */
+    getChannelRange(channel: ColorChannel): ColorChannelRange;
+    /**
+     * Returns the color space, 'rgb', 'hsb' or 'hsl', for the current color.
+     */
+    getFormat(): ColorFormat;
+    /**
+     * Returns the color space axes, xChannel, yChannel, zChannel.
+     */
+    getColorAxes(xyChannels: Color2DAxes): ColorAxes;
+    /**
+     * Returns an array of the color channels within the current color space space.
+     */
+    getChannels(): [ColorChannel, ColorChannel, ColorChannel];
+    /**
+     * Returns a new Color object with the same values as the current color.
+     */
+    clone(): ColorType;
+    /**
+     * Whether the color is equal to another color.
+     */
+    isEqual(color: ColorType): boolean;
+    /**
+     * Increments the color channel by the given step size, and returns a new Color object.
+     */
+    incrementChannel(channel: ColorChannel, stepSize: number): ColorType;
+    /**
+     * Decrements the color channel by the given step size, and returns a new Color object.
+     */
+    decrementChannel(channel: ColorChannel, stepSize: number): ColorType;
+    /**
+     * Returns the color channel value as a percentage of the channel range.
+     */
+    getChannelValuePercent(channel: ColorChannel, value?: number): number;
+    /**
+     * Returns the color channel value for a given percentage of the channel range.
+     */
+    getChannelPercentValue(channel: ColorChannel, percent: number): number;
+}
+
+export type { Color2DAxes, ColorAxes, ColorChannel, ColorChannelRange, ColorFormat, ColorHexFormat, ColorStringFormat, ColorType };

package/dist/types.js

@@ -0,0 +1,18 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zag-js/color-utils",
-  "version": "1.34.1",
+  "version": "1.35.1",
   "description": "Color utilities for zag.js",
   "keywords": [
     "js",
@@ -24,7 +24,7 @@
   },
   "clean-package": "../../../clean-package.config.json",
   "dependencies": {
-    "@zag-js/utils": "1.34.1"
+    "@zag-js/utils": "1.35.1"
   },
   "devDependencies": {
     "clean-package": "2.2.0"