# @dominate-color\.js/core 中文文档

规范地址：https://npmcn.com/package/%40dominate-color.js/core/

版本：1\.1\.1
npm 元数据更新时间：2024-10-14T11:39:15.042Z
中文译文更新时间：2026-11-12T15:37:33.517Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dominate-color.js/core
原文对照：https://npmcn.com/package/%40dominate-color.js/core/?lang=original
项目主页：https://github.com/Dominate-color/dominate-color-js#readme
源码仓库：https://github.com/Dominate-color/dominate-color-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：87.9 kB，52 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-12-03T19:19:39.811Z
- 最新版本发布：2024-10-14T11:39:14.638Z
- 近 30 天下载量：3989（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

一个库能以 RGBA 格式提取出主色调及其色调并进行转换.

## 安装

```sh
npm install @dominate-color.js/core
```

也可以使用：`pnpm add @dominate-color.js/core`、`yarn add @dominate-color.js/core`、`bun add @dominate-color.js/core`

## README

### `@dominate-color.js/core`

[![core-npm-badge](https://img.shields.io/npm/v/@dominate-color.js/core?logo=npm)](https://npmjs.com/package/@dominate-color.js/core) ![Size](https://img.shields.io/bundlephobia/minzip/@dominate-color.js/core) [![code-badge](https://img.shields.io/badge/source-black?logo=github)](https://github.com/Dominate-color/dominate-color-js/tree/master/packages/core)

一个强大的TypeScript库,用于图像中的颜色检测. 这个 `@dominate-color.js/core` 软件包提供了识别和从图像源取出主导颜色的基本功能。 图书馆的建设是为了迎合各种使用案例,从创建以色彩为主的美学布局到实施基于您应用中的图像颜色的动态主题.

#### `colorDetection()`

这个 `colorDetection` 函数是 `@dominate-color.js/core` 软件包,使开发人员能够轻松地检测图像中的颜色。 它接受一个图像源和可选配置参数,返回一个以图像中发现的最主要RGBA颜色的数组解决的许诺.

##### 特征

-   支持各种图像源,包括URL,文件路径和缓冲.
-   提供可配置设置来微调色彩检测.
-   利用高效的算法来快速而精确地提取颜色.

##### 开始

整合前 `colorDetection` 在您的项目中,最好通过所提供的文档了解如何有效使用该功能。 这个功能的设计是直截了当和灵活的,便于适应你的具体需要.

##### 安装

首先,安装 `@dominate-color.js/core` 使用 npm, pnpm 或纱线的软件包 :

```bash
npm install @dominate-color.js/core
# or
yarn add @dominate-color.js/core
```

##### 使用量

要在您的工程中使用颜色检测, 请遵循这些步骤 :

1.  从包中导入颜色检测函数 :

```typescript
import { colorDetection } from '@dominate-color.js/core';
```

2.  准备你的图像源。 这可以是 URL,本地文件路径,也可以是 ArrayBuffer.
3.  (可选)设置您的配置选项。 您可以指定距离方法、 要检测的颜色数字 K 和 COSOR 设置的 Access Control AllowOrigin .
4.  使用您的图像源和可选配置调用颜色检测 () :

```typescript
    import { colorDetection, type Config } from '@dominate-color.js/core';
     
    const config: Config = {
        distance: 'euclidean', // Choose the 'euclidean' algorithm for color distance calculation
        k: 5, // Detect the top 5 dominant colors
        AccessControlAllowOrigin: '*' // Useful for CORS when fetching images from external URLs
    };

    // Replace `source.url` with the path to your image or any other type supported by the `colorDetection` function when calling it.
    colorDetection(source.url, config)
        .then(colors => {
            console.log('Detected Colors with custom config:', colors);
            updateUIWithColors(colors);
        })
        .catch(error => {
            console.error('Error detecting colors with custom config:', error);
            warnUserSomethingWentWrong(error)
        });
```

## 常见问题

### @dominate-color\.js/core 是什么？

一个库能以 RGBA 格式提取出主色调及其色调并进行转换\.

### 如何安装 @dominate-color\.js/core？

在项目目录运行 npm install @dominate-color\.js/core，或使用 pnpm add / yarn add / bun add。

### @dominate-color\.js/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dominate-color\.js/core 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @dominate-color\.js/core 可以商用吗？

@dominate-color\.js/core 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dominate-color\.js/core 的下载量有多少？

根据 npm 官方下载统计，@dominate-color\.js/core 在 2026/10/13 – 2026/11/11 这 30 天内被下载 3,989 次，日均约 133 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dominate-color\.js/core 还在维护吗？

最新版本 1\.1\.1 发布于 2024/10/14（2 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2023/12/04。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。