# @glassfm/react-clarity 中文文档

规范地址：https://npmcn.com/package/%40glassfm/react-clarity/

版本：1\.0\.3
npm 元数据更新时间：2024-01-22T16:27:29.504Z
中文译文更新时间：2026-11-16T15:35:21.553Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40glassfm/react-clarity
原文对照：https://npmcn.com/package/%40glassfm/react-clarity/?lang=original
项目主页：https://github.com/GlassFM/react-clarity#readme

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

- 包体积（解压后）：4.9 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-01-22T15:12:36.670Z
- 最新版本发布：2024-01-22T16:27:29.323Z
- 近 30 天下载量：3697（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：4（近 12 个月 0 个）

## 中文简介

将 Microsoft- Clasary 应用到反应项目

## 安装

```sh
npm install @glassfm/react-clarity
```

也可以使用：`pnpm add @glassfm/react-clarity`、`yarn add @glassfm/react-clarity`、`bun add @glassfm/react-clarity`

## README

# GlassFM - 反应微软清晰度

轻量级组件, 使 Microsoft Clarity 更容易添加到您的项目中 .

# 安装

```bash
npm install react-microsoft-clarity --save
```

# 使用量

```typescript
import { clarity } from "react-microsoft-clarity";

// Start seeing data on the Clarity dashboard with your project ID
clarity.init(id);

// Identify the user
clarity.identify("USER_ID", "SESSION_ID", "PAGE_ID");

// Cookie consent
clarity.consent();

// Setup a custom tag
clarity.setTag("key", "value");

// Upgrade session
clarity.upgrade("upgradeReason");

// Check if Clarity has been initialized before calling its methods
if (clarity.hasStarted()) {
    clarity.identify("USER_ID", "SESSION_ID", "PAGE_ID", "FRIENDLY_NAME");
    clarity.setEvent("SOME_EVENT");
}
```

-   id: Stands for "Classary ID" - 在设置中发现了您站点的项目ID. 这是告诉Clarity应该装入哪个站点以及应该保存所收集数据的ID.

你可以多学点 [清晰文档](https://learn.microsoft.com/en-us/clarity/)

## 常见问题

### @glassfm/react-clarity 是什么？

将 Microsoft- Clasary 应用到反应项目

### 如何安装 @glassfm/react-clarity？

在项目目录运行 npm install @glassfm/react-clarity，或使用 pnpm add / yarn add / bun add。

### @glassfm/react-clarity 支持 TypeScript 吗？

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

### @glassfm/react-clarity 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @glassfm/react-clarity 可以商用吗？

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

### @glassfm/react-clarity 的下载量有多少？

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

### @glassfm/react-clarity 还在维护吗？

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

