iro.js 开源项目使用教程

2026-01-17 09:27:55作者：尤峻淳Whitney

1. 项目的目录结构及介绍

iro.js 项目的目录结构如下：

iro.js/
├── dist/
│   ├── iro.js
│   ├── iro.min.js
│   └── iro.css
├── src/
│   ├── css/
│   ├── js/
│   └── index.js
├── examples/
├── tests/
├── package.json
├── README.md
└── LICENSE

目录介绍：

dist/: 包含编译后的文件，包括 iro.js 和 iro.min.js，以及样式文件 iro.css。
src/: 源代码目录，包含 JavaScript 和 CSS 文件。
examples/: 示例代码，展示如何使用 iro.js。
tests/: 测试文件，用于测试 iro.js 的功能。
package.json: 项目的配置文件，包含依赖和脚本信息。
README.md: 项目说明文档。
LICENSE: 项目许可证文件。

2. 项目的启动文件介绍

iro.js 的启动文件是 dist/iro.js 或 dist/iro.min.js。这两个文件是编译后的版本，可以直接在项目中使用。

使用方法：

通过 CDN 引入：

<script src="https://cdn.jsdelivr.net/npm/@jaames/iro@5"></script>

通过 npm 安装并引入：

npm install @jaames/iro --save

import iro from '@jaames/iro';
// 或
const iro = require('@jaames/iro');

3. 项目的配置文件介绍

iro.js 的配置文件是 package.json，其中包含了项目的基本信息、依赖和脚本命令。

package.json 示例：

{
  "name": "iro.js",
  "version": "5.5.2",
  "description": "Modular color picker widget for JavaScript",
  "main": "dist/iro.js",
  "scripts": {
    "build": "rollup -c",
    "watch": "rollup -c -w",
    "test": "jest"
  },
  "dependencies": {},
  "devDependencies": {
    "@babel/core": "^7.12.3",
    "@babel/preset-env": "^7.12.1",
    "jest": "^26.6.3",
    "rollup": "^2.3.4",
    "rollup-plugin-babel": "^4.4.0",
    "rollup-plugin-commonjs": "^10.1.0",
    "rollup-plugin-node-resolve": "^5.2.0",
    "rollup-plugin-terser": "^7.0.2"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/jaames/iro.js.git"
  },
  "keywords": [
    "color",
    "picker",
    "colorpicker",
    "ui",
    "widget"
  ],
  "author": "James Daniel",
  "license": "MPL-2.0",
  "bugs": {
    "url": "https://github.com/jaames/iro.js/issues"
  },
  "homepage": "https://iro.js.org"
}