颜色 – API | Bun 文档

Bun.color(input, outputFormat?) 利用 Bun 的 CSS 解析器来解析、规范化和转换用户输入的颜色到各种输出格式，包括

格式	示例
`"css"`	`"red"`
`"ansi"`	`"\x1b[38;2;255;0;0m"`
`"ansi-16"`	`"\x1b[38;5;\tm"`
`"ansi-256"`	`"\x1b[38;5;196m"`
`"ansi-16m"`	`"\x1b[38;2;255;0;0m"`
`"number"`	`0x1a2b3c`
`"rgb"`	`"rgb(255, 99, 71)"`
`"rgba"`	`"rgba(255, 99, 71, 0.5)"`
`"hsl"`	`"hsl(120, 50%, 50%)"`
`"hex"`	`"#1a2b3c"`
`"HEX"`	`"#1A2B3C"`
`"{rgb}"`	`{ r: 255, g: 99, b: 71 }`
`"{rgba}"`	`{ r: 255, g: 99, b: 71, a: 1 }`
`"[rgb]"`	`[ 255, 99, 71 ]`
`"[rgba]"`	`[ 255, 99, 71, 255]`

有许多不同的方式来使用这个 API

验证和规范化颜色以持久保存在数据库中（number 是最适合数据库的格式）
将颜色转换为不同的格式
超出当今许多人使用的 16 种颜色的彩色日志记录（如果您不想弄清楚用户的终端支持什么，请使用 ansi，否则请根据终端支持的颜色数量使用 ansi-16、ansi-256 或 ansi-16m）
格式化颜色以用于注入到 HTML 中的 CSS
从 CSS 颜色字符串中获取 `r`、`g`、`b` 和 `a` 颜色分量作为 JavaScript 对象或数字

您可以将此视为流行的 npm 包 color 和 tinycolor2 的替代方案，但它完全支持解析 CSS 颜色字符串，并且零依赖，直接构建于 Bun 中。

灵活的输入

您可以传入以下任何一种

标准的 CSS 颜色名称，例如 "red"
数字，例如 0xff0000
十六进制字符串，例如 "#f00"
RGB 字符串，例如 "rgb(255, 0, 0)"
RGBA 字符串，例如 "rgba(255, 0, 0, 1)"
HSL 字符串，例如 "hsl(0, 100%, 50%)"
HSLA 字符串，例如 "hsla(0, 100%, 50%, 1)"
RGB 对象，例如 { r: 255, g: 0, b: 0 }
RGBA 对象，例如 { r: 255, g: 0, b: 0, a: 1 }
RGB 数组，例如 [255, 0, 0]
RGBA 数组，例如 [255, 0, 0, 255]
LAB 字符串，例如 "lab(50% 50% 50%)"
... 任何其他 CSS 可以解析为单个颜色值的格式

将颜色格式化为 CSS

"css" 格式输出有效的 CSS，用于样式表、内联样式、CSS 变量、css-in-js 等。它返回颜色最紧凑的字符串表示形式。

Bun.color("red", "css"); // "red"
Bun.color(0xff0000, "css"); // "#f000"
Bun.color("#f00", "css"); // "red"
Bun.color("#ff0000", "css"); // "red"
Bun.color("rgb(255, 0, 0)", "css"); // "red"
Bun.color("rgba(255, 0, 0, 1)", "css"); // "red"
Bun.color("hsl(0, 100%, 50%)", "css"); // "red"
Bun.color("hsla(0, 100%, 50%, 1)", "css"); // "red"
Bun.color({ r: 255, g: 0, b: 0 }, "css"); // "red"
Bun.color({ r: 255, g: 0, b: 0, a: 1 }, "css"); // "red"
Bun.color([255, 0, 0], "css"); // "red"
Bun.color([255, 0, 0, 255], "css"); // "red"

如果输入未知或解析失败，Bun.color 返回 null。

将颜色格式化为 ANSI（用于终端）

"ansi" 格式输出 ANSI 转义码，用于在终端中使文本色彩化。

Bun.color("red", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color(0xff0000, "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("#f00", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("#ff0000", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("rgb(255, 0, 0)", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("rgba(255, 0, 0, 1)", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("hsl(0, 100%, 50%)", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color("hsla(0, 100%, 50%, 1)", "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color({ r: 255, g: 0, b: 0 }, "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color({ r: 255, g: 0, b: 0, a: 1 }, "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color([255, 0, 0], "ansi"); // "\u001b[38;2;255;0;0m"
Bun.color([255, 0, 0, 255], "ansi"); // "\u001b[38;2;255;0;0m"

这会获取 stdout 的颜色深度，并根据环境变量自动选择 "ansi-16m"、"ansi-256"、"ansi-16" 之一。如果 stdout 不支持任何形式的 ANSI 颜色，则返回空字符串。与 Bun 的其余颜色 API 一样，如果输入未知或解析失败，则返回 null。

24 位 ANSI 颜色 (`ansi-16m`)

"ansi-16m" 格式输出 24 位 ANSI 颜色，用于在终端中使文本色彩化。24 位颜色意味着您可以在支持的终端上显示 1600 万种颜色，并且需要支持它的现代终端。

这会将输入的颜色转换为 RGBA，然后将其作为 ANSI 颜色输出。

Bun.color("red", "ansi-16m"); // "\x1b[38;2;255;0;0m"
Bun.color(0xff0000, "ansi-16m"); // "\x1b[38;2;255;0;0m"
Bun.color("#f00", "ansi-16m"); // "\x1b[38;2;255;0;0m"
Bun.color("#ff0000", "ansi-16m"); // "\x1b[38;2;255;0;0m"

256 ANSI 颜色 (`ansi-256`)

"ansi-256" 格式将输入的颜色近似为某些终端支持的 256 种 ANSI 颜色中最接近的一种。

Bun.color("red", "ansi-256"); // "\u001b[38;5;196m"
Bun.color(0xff0000, "ansi-256"); // "\u001b[38;5;196m"
Bun.color("#f00", "ansi-256"); // "\u001b[38;5;196m"
Bun.color("#ff0000", "ansi-256"); // "\u001b[38;5;196m"

为了从 RGBA 转换为 256 种 ANSI 颜色之一，我们移植了 tmux 使用的算法。

16 ANSI 颜色 (`ansi-16`)

"ansi-16" 格式将输入的颜色近似为大多数终端支持的 16 种 ANSI 颜色中最接近的一种。

Bun.color("red", "ansi-16"); // "\u001b[38;5;\tm"
Bun.color(0xff0000, "ansi-16"); // "\u001b[38;5;\tm"
Bun.color("#f00", "ansi-16"); // "\u001b[38;5;\tm"
Bun.color("#ff0000", "ansi-16"); // "\u001b[38;5;\tm"

这首先将输入转换为 24 位 RGB 颜色空间，然后转换为 ansi-256，然后再将其转换为最接近的 16 种 ANSI 颜色。

将颜色格式化为数字

"number" 格式输出一个 24 位数字，用于数据库、配置或任何其他需要颜色紧凑表示形式的用例。

Bun.color("red", "number"); // 16711680
Bun.color(0xff0000, "number"); // 16711680
Bun.color({ r: 255, g: 0, b: 0 }, "number"); // 16711680
Bun.color([255, 0, 0], "number"); // 16711680
Bun.color("rgb(255, 0, 0)", "number"); // 16711680
Bun.color("rgba(255, 0, 0, 1)", "number"); // 16711680
Bun.color("hsl(0, 100%, 50%)", "number"); // 16711680
Bun.color("hsla(0, 100%, 50%, 1)", "number"); // 16711680

获取红色、绿色、蓝色和 alpha 通道

您可以使用 "{rgba}"、"{rgb}"、"[rgba]" 和 "[rgb]" 格式来获取红色、绿色、蓝色和 alpha 通道，以对象或数组的形式。

`{rgba}` 对象

"{rgba}" 格式输出一个包含红色、绿色、蓝色和 alpha 通道的对象。

type RGBAObject = {
  // 0 - 255
  r: number;
  // 0 - 255
  g: number;
  // 0 - 255
  b: number;
  // 0 - 1
  a: number;
};

示例

Bun.color("hsl(0, 0%, 50%)", "{rgba}"); // { r: 128, g: 128, b: 128, a: 1 }
Bun.color("red", "{rgba}"); // { r: 255, g: 0, b: 0, a: 1 }
Bun.color(0xff0000, "{rgba}"); // { r: 255, g: 0, b: 0, a: 1 }
Bun.color({ r: 255, g: 0, b: 0 }, "{rgba}"); // { r: 255, g: 0, b: 0, a: 1 }
Bun.color([255, 0, 0], "{rgba}"); // { r: 255, g: 0, b: 0, a: 1 }

为了表现得类似于 CSS，a 通道是一个介于 0 和 1 之间的小数。

"{rgb}" 格式类似，但不包含 alpha 通道。

Bun.color("hsl(0, 0%, 50%)", "{rgb}"); // { r: 128, g: 128, b: 128 }
Bun.color("red", "{rgb}"); // { r: 255, g: 0, b: 0 }
Bun.color(0xff0000, "{rgb}"); // { r: 255, g: 0, b: 0 }
Bun.color({ r: 255, g: 0, b: 0 }, "{rgb}"); // { r: 255, g: 0, b: 0 }
Bun.color([255, 0, 0], "{rgb}"); // { r: 255, g: 0, b: 0 }

`[rgba]` 数组

"[rgba]" 格式输出一个包含红色、绿色、蓝色和 alpha 通道的数组。

// All values are 0 - 255
type RGBAArray = [number, number, number, number];

示例

Bun.color("hsl(0, 0%, 50%)", "[rgba]"); // [128, 128, 128, 255]
Bun.color("red", "[rgba]"); // [255, 0, 0, 255]
Bun.color(0xff0000, "[rgba]"); // [255, 0, 0, 255]
Bun.color({ r: 255, g: 0, b: 0 }, "[rgba]"); // [255, 0, 0, 255]
Bun.color([255, 0, 0], "[rgba]"); // [255, 0, 0, 255]

与 "{rgba}" 格式不同，alpha 通道是一个介于 0 和 255 之间的整数。这对于类型化数组很有用，在类型化数组中，每个通道都必须是相同的底层类型。

"[rgb]" 格式类似，但不包含 alpha 通道。

Bun.color("hsl(0, 0%, 50%)", "[rgb]"); // [128, 128, 128]
Bun.color("red", "[rgb]"); // [255, 0, 0]
Bun.color(0xff0000, "[rgb]"); // [255, 0, 0]
Bun.color({ r: 255, g: 0, b: 0 }, "[rgb]"); // [255, 0, 0]
Bun.color([255, 0, 0], "[rgb]"); // [255, 0, 0]

将颜色格式化为十六进制字符串

"hex" 格式输出小写十六进制字符串，用于 CSS 或其他上下文中。

Bun.color("hsl(0, 0%, 50%)", "hex"); // "#808080"
Bun.color("red", "hex"); // "#ff0000"
Bun.color(0xff0000, "hex"); // "#ff0000"
Bun.color({ r: 255, g: 0, b: 0 }, "hex"); // "#ff0000"
Bun.color([255, 0, 0], "hex"); // "#ff0000"

"HEX" 格式类似，但它输出大写字母而不是小写字母的十六进制字符串。

Bun.color("hsl(0, 0%, 50%)", "HEX"); // "#808080"
Bun.color("red", "HEX"); // "#FF0000"
Bun.color(0xff0000, "HEX"); // "#FF0000"
Bun.color({ r: 255, g: 0, b: 0 }, "HEX"); // "#FF0000"
Bun.color([255, 0, 0], "HEX"); // "#FF0000"

Bundle-time 客户端颜色格式化

与 Bun 的许多 API 一样，您可以使用宏在 bundle-time 调用 Bun.color，以便在客户端 JavaScript 构建中使用

client-side.ts
import { color } from "bun" with { type: "macro" };

console.log(color("#f00", "css"));

然后，构建客户端代码

bun build ./client-side.ts

这将输出以下内容到 client-side.js

// client-side.ts
console.log("red");