onecolor 项目技术文档

1. 安装指南

onecolor 项目可以通过以下两种包管理器进行安装：

• npm: 在命令行中运行 npm install onecolor。
• bower: 在命令行中运行 bower install color。

2. 项目的使用说明

onecolor 是一个 JavaScript 颜色计算工具包，适用于 node.js 和浏览器环境。它支持多种颜色空间，包括 RGB、HSV、HSL、CMYK 等（LAB 和 XYZ 为实验性实现），并且提供了丰富的颜色操作功能。

在浏览器中使用时，可以通过 <script> 标签引入 one-color.js 文件。例如：

<script src="one-color.js"></script>
<script>
  alert('Hello, ' + one.color('#650042').lightness(0.3).green(0.4).hex() + ' world!');
</script>

在 node.js 环境中，可以通过 require 引入模块：

var color = require('onecolor');
console.warn(color('rgba(100%, 0%, 0%, .5)').alpha(0.4).cssa());

3. 项目API使用文档

onecolor 提供了丰富的 API 用于创建和操作颜色对象。

颜色解析函数

以下为创建颜色实例的推荐方式：

color('#a9d91d'); // 常规十六进制语法
color('a9d91d'); // 十六进制语法，# 可省略
color('#eee'); // 简写十六进制语法
color('rgb(124, 96, 200)'); // CSS rgb 语法
color('rgba(124, 96, 200, .4)'); // CSS rgba 语法
color('hsl(120, 75%, 75%)'); // CSS hsl 语法
color('hsla(120, 75%, 75%, .1)'); // CSS hsla 语法

序列化方法

以下为颜色实例的序列化方法：

var myColor = color('#bda65b');

myColor.hex(); // 返回 6 位十六进制字符串
myColor.css(); // 返回 CSS rgb 语法
myColor.cossa(); // 返回 CSS rgba 语法
myColor.toString(); // 用于调试：返回颜色实例的字符串表示
myColor.toJSON(); // 返回颜色实例的 JSON 表示

获取器和设置器

获取器返回颜色通道的值，设置器返回一个新的颜色实例，其中一个通道的值已更改：

var myColor = color('#bda65b');

myColor.red();
myColor.green();
myColor.blue();
myColor.hue();
myColor.saturation();
myColor.value();
myColor.lightness();
myColor.alpha();

color.red(<number>);
color.green(<number>);
color.blue(<number>);
color.hue(<number>);
color.saturation(<number>);
color.value(<number>);
color.lightness(<number>);
color.alpha(<number>);

调整器

调整器返回一个新的颜色实例，其中一个通道的值按照指定的增量进行调整：

color.red(<number>, true);
color.green(<number>, true);
color.blue(<number>, true);
color.hue(<number>, true);
color.saturation(<number>, true);
color.value(<number>, true);
color.lightness(<number>, true);
color.alpha(<number>, true);

比较颜色对象

以下方法用于比较两个颜色实例是否代表相同的颜色：

color.equals(otherColor[, <epsilon>]);

4. 项目安装方式

项目的安装方式已在“安装指南”部分进行了说明。您可以使用 npm 或 bower 包管理器来安装 onecolor 项目。