# @anatoliygatt/use-prefers-color-scheme 中文文档

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

版本：1\.0\.10
npm 元数据更新时间：2023-04-27T08:50:28.886Z
中文译文更新时间：2026-11-06T02:06:34.695Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：13.4 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：react ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2022-01-18T13:31:56.078Z
- 最新版本发布：2023-04-27T08:50:28.767Z
- 近 30 天下载量：16932（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

用户颜色方案偏好签名的响应钩 .

## 安装

```sh
npm install @anatoliygatt/use-prefers-color-scheme
```

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

## README

  

![use-prefers-color-scheme Logo](https://i.imgur.com/71mYMjx.png)

  

# 使用偏好- 颜色- 方案

### [反应](https://reactjs.org/) 用户颜色方案首选项的订阅钩 .

  

 [![Github CI Workflow Status](https://img.shields.io/github/actions/workflow/status/anatoliygatt/use-prefers-color-scheme/ci.yml?branch=master&style=for-the-badge&logo=github&label=CI&labelColor=000000)](https://github.com/anatoliygatt/use-prefers-color-scheme/actions?query=workflow%3ACI)[![NPM Version](https://img.shields.io/npm/v/@anatoliygatt/use-prefers-color-scheme.svg?style=for-the-badge&logo=npm&labelColor=000000) ](https://www.npmjs.com/package/@anatoliygatt/use-prefers-color-scheme)[![License](https://img.shields.io/github/license/anatoliygatt/use-prefers-color-scheme.svg?style=for-the-badge&logo=opensourceinitiative&logoColor=ffffff&labelColor=000000)](https://github.com/anatoliygatt/use-prefers-color-scheme/blob/master/LICENSE)

  

## 开始

### QQ 跳出开始

```shell
npm install @anatoliygatt/use-prefers-color-scheme
```

```jsx
import { usePrefersColorScheme } from '@anatoliygatt/use-prefers-color-scheme';

function Example() {
  const preferredColorScheme = usePrefersColorScheme();
  const isDarkColorSchemePreferred = preferredColorScheme === 'dark';
  return (
    <div>
      Preferred Color Scheme:{' '}
      {isDarkColorSchemePreferred ? '🌚 Dark' : '🌞 Light'}
    </div>
  );
}
```

### 现场直播

[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/demo-for-anatoliygatt-use-prefers-color-scheme-llkul)

## 使用服务器侧渲染( SSR)

像"Next.js"和"Gatsby"这样的框架利用了服务器侧渲染,这意味着HTML在发送到浏览器之前的某个时候是被预发的. 当我们第一次制作反应元件树时,我们不知道用户是否更喜欢浅色或暗色方案.

它可能导致水合过程中加分不匹配. 为了防止这种情况,我们需要制定 `ssr` 选项 `usePrefersColorScheme()` 钩入 `true`,像这样:

```javascript
usePrefersColorScheme({ ssr: true });
```

这将保证在原始服务器渲染和第一个客户端渲染之间不会出现标记不匹配,但是,我们必须作出妥协:强制一种暗色方案用于 **_所有用户_** 在第一个渲染.

## 许可证

[麻省理工学院](https://github.com/anatoliygatt/use-prefers-color-scheme/blob/master/LICENSE)

## 常见问题

### @anatoliygatt/use-prefers-color-scheme 是什么？

用户颜色方案偏好签名的响应钩 \.

### 如何安装 @anatoliygatt/use-prefers-color-scheme？

在项目目录运行 npm install @anatoliygatt/use-prefers-color-scheme，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @anatoliygatt/use-prefers-color-scheme 支持 TypeScript 吗？

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

### @anatoliygatt/use-prefers-color-scheme 支持 ESM 还是 CommonJS？

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

### @anatoliygatt/use-prefers-color-scheme 可以商用吗？

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

### @anatoliygatt/use-prefers-color-scheme 的下载量有多少？

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

### @anatoliygatt/use-prefers-color-scheme 还在维护吗？

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