# @flourish/custom-colors 中文文档

规范地址：https://npmcn.com/package/%40flourish/custom-colors/

版本：3\.0\.1
npm 元数据更新时间：2026-08-19T18:13:17.928Z
中文译文更新时间：2026-11-16T01:06:01.131Z
软件包许可：UNLICENSED

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

原始 npm 页面：https://www.npmjs.com/package/%40flourish/custom-colors
原文对照：https://npmcn.com/package/%40flourish/custom-colors/?lang=original
项目主页：https://github.com/kiln/flourish-custom-colors#readme
源码仓库：https://github.com/kiln/flourish-custom-colors

弃用说明：This project has been renamed to @flourish/colors

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

- 包体积（解压后）：112 kB，12 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：未声明
- 运行依赖：6 个
- 首次发布：2018-08-01T11:23:37.200Z
- 最新版本发布：2020-03-30T16:18:29.080Z
- 近 30 天下载量：1967（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

添加自定义颜色设置

## 安装

```sh
npm install @flourish/custom-colors
```

也可以使用：`pnpm add @flourish/custom-colors`、`yarn add @flourish/custom-colors`、`bun add @flourish/custom-colors`

## README

# 面粉自定义颜色

添加设置和逻辑, 以方便在模板中添加自定义颜色

## 安装

`npm install @flourish/custom-colors`

## 基本用途

这个 `settings.yml` 文件应当导入到模板中 `template.yml` 文件,像这样 :

```yaml
  - Colours
  - property: color
    import: "@flourish/custom-colors"
```

导入软件包像 `import createCustomColors from "@flourish/custom-colors"`

`var colors = createCustomColors(state.color)` 创建新对象 `colors`。 。 。 .

您只需要在状态下通过, 颜色功能才能工作 .

## 方法

`colors.getColor(value)` 找到正确的颜色 `value`。将只返回倒计时值,除非更新的Color Scale方法在某个时候被调用.

`colors.fallback([value])` 如果 `value` 未定义或(通常)设置为 `value` 如果定义并返回 `colors` 对象。 这个 `value` “ 默认” (重新) 设定倒计时值为无效的默认值 。 每逢 `getColor` 方法不能解释传入它的值(例如,当该值处于相继或相差模式时是非数字值).

`colors.stringNormalizer([func])` 返回当前字符串正常化函数,如果 `func` 未定义或(通常)设置为 `func` 如果定义并返回 `colors` 对象。 这个 `value` "default"(re)将常态函数设置为小写输入并去掉白空格的函数. 传递非函数的任何其他值(如:. `null`告诉 `colors` 反对不实现任何正常化.

字符串正常化函数只在绝对模式下使用 。 其宗旨是允许在输入数据中拼写时出现(被开发者所看到)相差(如大小写和白相差). 在调用价值后 `func`,则 `updateColorScale` 应当使用方法.

`colors.updateColorScale(domain)` 基于 `domain` 阵列.

## 常见问题

### @flourish/custom-colors 是什么？

添加自定义颜色设置注意：该包已被作者标记为弃用——This project has been renamed to @flourish/colors

### 如何安装 @flourish/custom-colors？

在项目目录运行 npm install @flourish/custom-colors，或使用 pnpm add / yarn add / bun add。

### @flourish/custom-colors 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/flourish\_\_custom-colors 是否存在。

### @flourish/custom-colors 支持 ESM 还是 CommonJS？

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

### @flourish/custom-colors 可以商用吗？

@flourish/custom-colors 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @flourish/custom-colors 的下载量有多少？

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

### @flourish/custom-colors 还在维护吗？

最新版本 3\.0\.1 发布于 2020/03/31（6 年前）；至今共发布 16 个版本，其中过去 12 个月发布了 0 个；首次发布于 2018/08/01。作者已将其标记为弃用，新项目建议寻找替代方案。

