ph-utils/lib/color.d.ts

js 开发工具集，前后端都可以使用(commonjs和es module)

type RGBColorObject = {
    r: number;
    g: number;
    b: number;
    a?: number;
};
type HSVColorObject = {
    h: number;
    s: number;
    v: number;
};
/**
 * 将输入的颜色值转换为RGB对象格式。
 *
 * @param color 可以是字符串, 也可以是一个 HSV 对象[一个包含 h、s、v 属性的对象]
 * @returns 返回一个包含r、g、b和a（透明度）属性的RGB对象。
 * @throws 如果输入的字符串不是有效的颜色表示，则抛出错误。
 */
export declare function toRgb(color: any): RGBColorObject;
/**
 * 将颜色转换为HSV颜色模型。
 *
 * @param color - 字符串或者RGB对象
 * @returns 返回一个包含h、s、v属性的对象，代表HSV颜色值，其中h是色相（取值范围0到360），s是饱和度（取值范围0到1），v是明度（取值范围0到1）。
 */
export declare function toHsv(color: any): HSVColorObject;
/**
 * 将RGB颜色对象转换为十六进制颜色字符串。
 * @param rgb - 包含红色(r), 绿色(g), 蓝色(b)成分的对象。
 * @returns 返回一个表示RGB颜色的十六进制字符串，例如"#FF0000"。
 */
export declare function rgbToHex(rgb: RGBColorObject): string;
/**
 * 将颜色转换为 16 进制字符串
 * @param color - 颜色, 可以 rgb(0,0,0),rgba(0,0,0,0)字符串, 也可以是 rgb、hsv对象
 * @returns 返回颜色的十六进制字符串，例如"#FF0000"
 */
export declare function toHex(color: any): string;
/**
 * 调整给定颜色深[darken]浅[lighten]
 * @param color - 输入的颜色，可以是任意颜色表示方式
 * @param level - 调整深浅级别, 可以是小数。默认: 1
 * @param light - 控制调整的方向。如果为true，[lighten] 变浅，如果为false，[darken] 变深。默认: true
 *
 * #### 1. 颜色变浅
 *
 * ```
 * adjust('#4998f4', 3, true)
 * ```
 *
 * @returns 返回调整后颜色的十六进制字符串表示。
 */
export declare function adjust(color: any, level?: number, light?: boolean): string;
export {};