# @dazl/color-scheme 中文文档

规范地址：https://npmcn.com/package/%40dazl/color-scheme/

版本：1\.3\.0
npm 元数据更新时间：2026-08-07T07:10:25.180Z
中文译文更新时间：2026-11-11T16:41:55.571Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：17.7 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2025-07-02T10:48:41.843Z
- 最新版本发布：2026-06-16T10:39:50.431Z
- 近 30 天下载量：24051（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 1 个）

## 中文简介

彩色方案公用事业和工具

## 安装

```sh
npm install @dazl/color-scheme
```

也可以使用：`pnpm add @dazl/color-scheme`、`yarn add @dazl/color-scheme`、`bun add @dazl/color-scheme`

## README

# @dazl/ 彩色计划

一个简单的网络应用色彩方案管理库,支持光/暗主题和自动系统偏好检测.

## 特征

-   🌓 **浅/暗/系统模式** - 支持轻、暗和自动系统优先检测
-   📱 **系统偏好检测** - 自动响应OS级主题变化
-   ⚛️ **反应整合** - 准备使用反应钩以无缝结合
-   💾 **持续储存** - 记得使用本地Storage的用户偏好
-   🎨 **CSS 类管理** - 自动将主题类应用到文档根
-   🏷️ **自动样式插入** - 注射这个 `color-scheme` 本地浏览器主题文档根上的 CSS 属性
-   📦 **零依赖关系** - 重量轻而无外部依赖
-   🔧 **类型脚本支持** - 包括全部类型脚本定义

## 安装

```bash
npm install @dazl/color-scheme
```

## 使用量

### 客户端设置

导入客户端模块以初始化色彩方案管理 :

> **说明:** 此导入只应在客户端代码中使用, 必须运行于 `<body>` 已执行。 要取得最佳效果,请将其收录入内含剧本.

```typescript
import '@dazl/color-scheme/client';

// The color scheme API is now available globally
const currentScheme = window.colorSchemeApi.current;
console.log(currentScheme); // { config: 'system', resolved: 'dark' }

// Change the color scheme
window.colorSchemeApi.config = 'light';

// Subscribe to changes
const unsubscribe = window.colorSchemeApi.subscribe(({ config, resolved }) => {
  console.log(`Color scheme changed: ${config} (resolved: ${resolved})`);
});
```

#### 色彩化学 API

-   **`config`** (单位:千美元)`light|dark|system`) - 获取或设置当前颜色方案配置
-   **`currentState`** (单位:千美元)`{ config: light|dark|system, resolved: light|dark }`) - 获取当前状态,包括配置和解析值
-   **`resolvedSystem`** (单位:千美元)`light|dark`) - 根据系统偏好获取已解决的主题
-   **`subscribe`** (单位:千美元)`(handler: (currentState) => void) => () => void`) - 订阅颜色方案更改并返回未订阅的函数
-   **`getRootCssClass`** (单位:千美元)`(resolved?: light|dark) => string`) - CSS 类应用到基于已解析主题或已传递值的文档根上

#### 覆盖根 CSS 类

通过指定来覆盖适用于文档根的默认 CSS 类 `data-dark-class` 财务报告和审定财务报表 `data-light-class` 客户端脚本标签中的属性 :

```html
<script src="@dazl/color-scheme/client" data-dark-class="dark-theme" data-light-class="light-theme"></script>
```

### 反应集成

使用 resact 钩子进行简单整合 :

```tsx
import { useColorScheme } from '@dazl/color-scheme/react';

function ThemeToggle() {
  const { configScheme, resolvedScheme, setColorScheme, isLight, isDark } = useColorScheme();

  return (
    <div>
      <p>Current config: {configScheme}</p>
      <p>Resolved theme: {resolvedScheme}</p>
      <p>Is light theme: {isLight}</p>
      <p>Is dark theme: {isDark}</p>

      <button onClick={() => setColorScheme('light')}>Light Theme</button>
      <button onClick={() => setColorScheme('dark')}>Dark Theme</button>
      <button onClick={() => setColorScheme('system')}>System Theme</button>
    </div>
  );
}
```

#### 虎克 API

-   **`resolvedScheme`** (单位:千美元)`light|dark`\- 确定的主题(浅/暗)
-   **`configScheme`** (单位:千美元)`light|dark|system`) - 当前配置(轻/暗/系统)
-   **`setColorScheme`** (单位:千美元)`(config: light|dark|system) => void`) - 改变颜色方案的函数
-   **`isLight`** (单位:千美元)`boolean`) - 当前解决的主题是否轻取
-   **`isDark`** (单位:千美元)`boolean`) - 当前解决的主题是否为暗色
-   **`rootCssClass`** (单位:千美元)`string`) - CSS 类应用到基于已解决主题的文档根上

### CSS 结构化

库自动将 CSS 类应用到文档根. 相应的应用程序样式 :

```css
/* Dark theme styles */
:root.dark-theme {
  --bg-color: #000000;
  --text-color: #ffffff;
}

/* Light theme styles (explicit) */
:root.light-theme {
  --bg-color: #ffffff;
  --text-color: #000000;
}
```

## 许可证

麻省理工学院

## 常见问题

### @dazl/color-scheme 是什么？

彩色方案公用事业和工具

### 如何安装 @dazl/color-scheme？

在项目目录运行 npm install @dazl/color-scheme，或使用 pnpm add / yarn add / bun add。

### @dazl/color-scheme 支持 TypeScript 吗？

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

### @dazl/color-scheme 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dazl/color-scheme 可以商用吗？

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

### @dazl/color-scheme 的下载量有多少？

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

### @dazl/color-scheme 还在维护吗？

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