# @clerk/chrome-extension 中文文档

规范地址：https://npmcn.com/package/%40clerk/chrome-extension/

版本：3\.1\.107
npm 元数据更新时间：2026-11-14T00:15:05.685Z
中文译文更新时间：2026-11-14T00:17:06.247Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clerk/chrome-extension
原文对照：https://npmcn.com/package/%40clerk/chrome-extension/?lang=original
项目主页：https://clerk.com/
源码仓库：https://github.com/clerk/javascript

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

- 包体积（解压后）：3.3 MB，87 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.9\.0
- 运行依赖：5 个
- peer 依赖：react ^18\.0\.0 \|\| ~19\.0\.3 \|\| ~19\.1\.4 \|\| ~19\.2\.3 \|\| ~19\.3\.0-0，react-dom ^18\.0\.0 \|\| ~19\.0\.3 \|\| ~19\.1\.4 \|\| ~19\.2\.3 \|\| ~19\.3\.0-0
- 首次发布：2023-03-31T14:43:40.455Z
- 最新版本发布：2026-11-14T00:15:05.309Z
- 近 30 天下载量：391899（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：6988（近 12 个月 2560 个）

## 中文简介

Chrome 扩展名的办事员 SDK

## 安装

```sh
npm install @clerk/chrome-extension
```

也可以使用：`pnpm add @clerk/chrome-extension`、`yarn add @clerk/chrome-extension`、`bun add @clerk/chrome-extension`

## README

[![](https://images.clerk.com/static/logo-light-mode-400x400.png)](https://clerk.com/?utm_source=github&utm_medium=clerk_chrome_extension)  

# @ clerk/ chrome-扩展

[![Chat on Discord](https://img.shields.io/discord/856971667393609759.svg?logo=discord)](https://clerk.com/discord) [![Clerk documentation](https://img.shields.io/badge/documentation-clerk-green.svg)](https://clerk.com/docs?utm_source=github&utm_medium=clerk_chrome_extension) [![Follow on X](https://img.shields.io/twitter/follow/clerk?style=social)](https://x.com/intent/follow?screen_name=clerk)

[更改日志](https://github.com/clerk/javascript/blob/main/packages/chrome-extension/CHANGELOG.md) • 妇女 [报告错误](https://github.com/clerk/javascript/issues/new?assignees=&labels=needs-triage&projects=&template=BUG_REPORT.yml) • 妇女 [请求特性](https://feedback.clerk.com/roadmap) • 妇女 [找人帮忙](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_chrome_extension)

## 开始

[办事员](https://clerk.com/?utm_source=github&utm_medium=clerk_chrome_extension) 是将认证和用户管理添加到浏览器扩展的简单方法。 在您的应用程序中添加签名、 签名和配置管理 .

### 先决条件

-   节点.js `>=20.9.0` 或稍后时间
-   现有办事员应用程序. [免费创建您的账户](https://dashboard.clerk.com/sign-up?utm_source=github&utm_medium=clerk_chrome_extension)。 。 。 .
-   已有的 React app (使用) [维特](https://crxjs.dev/vite-plugin/) (例如)

### 特性支持

请参看最近的扩展名 [认证支持矩阵](https://clerk.com/docs/references/chrome-extension/overview?utm_source=github&utm_medium=clerk_chrome_extension) 在办事员文档中提供更多信息.

### 使用量

1.  **安装 :** `npm install @clerk/chrome-extension`
    
2.  **设置一个一致的扩展密钥**:浏览器扩展可被其独特的密钥识别出,其方式类似于网站如何被其域名识别出. 您需要明确配置您的扩展名的密钥, 否则会经常更改 。 如果密钥改变,则可能导致扩展失败. 见 [配置一致的密钥](https://clerk.com/docs/references/chrome-extension/configure-consistent-crx-id?utm_source=github&utm_medium=clerk_chrome_extension) 更多信息指南.
    
3.  **更新办事员设置**: 一旦设置了一致的扩展密钥,您就需要配置您的办事员设置,允许扩展与您的办事员API通信. 您可以在您的办事员设置中将扩展键添加到允许的出处列表中。 设置 `allowed_origins` 实值 **所需经费** 两者 **发展** 财务报告和审定财务报表 **生产** 实例.
    
    ```bash
    curl  -X PATCH https://api.clerk.com/v1/instance \
          -H "Content-type: application/json" \
          -H "Authorization: Bearer <CLERK_SECRET_KEY>" \
          -d '{"allowed_origins": ["chrome-extension://<YOUR_EXTENSION_KEY>"]}'
    ```
    
4.  **设置环境变量 :** 获取 **可公布的密钥** 从你的 [办事员仪表板](https://dashboard.clerk.com/~/api-keys?utm_source=github&utm_medium=clerk_chrome_extension) 并将其设定为环境变量.
    
    ```sh
    # Vite
    VITE_CLERK_PUBLISHABLE_KEY=pk_test_xxx
    ```
    
    ```sh
    # Plasmo
    PLASMO_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_xxx
    ```
    
5.  **更新扩展名列表 :** 您需要更新您的扩展列表 允许支持办事员.
    
    1.  [**基础配置**数字 :](https://npmcn.com/packages/chrome-extension/docs/manifest.md#base-configuration) 如果您只计划在扩展语境中使用 Clerk , 请使用此选项 .
    2.  [**会话同步配置**数字 :](https://npmcn.com/packages/chrome-extension/docs/manifest.md#sync-host-configuration) 如果您计划在同一浏览器中共享一个网站的认证, 请使用此选项 .
6.  **在您的应用程序中添加办事员 :** 虽然不需要,但我们一般建议使用Plasmo来开发浏览器扩展. 这将在您的扩展中执行共同的标准, 并在未来更容易与其他浏览器进行整合 .
    
    1.  [**通过 `ClerkProvider`数字 :**](https://npmcn.com/packages/chrome-extension/docs/clerk-provider.md) 这是对所有扩展的一般办法。 从这里你就可以支持只扩展认证,以及在同一浏览器中与一个网站共享认证.
    2.  [**服务人员**数字 :](https://npmcn.com/packages/chrome-extension/docs/service-workers.md) 如果您还需要使用背景服务人员,您可以从扩展语境访问办事员客户端.

## 示例存储器

-   [快速启动](https://github.com/clerk/clerk-chrome-extension-quickstart): 扩展正在使用自己的认证
-   [服务工人和 `react-router`](https://github.com/clerk/clerk-chrome-extension-demo): 扩展认证与同一浏览器中的网站共享, 需要从服务工作者的办事员处获取用户信息或需要使用 `react-router`

## 支助

帮帮忙,来看我们 [支持页面](https://clerk.com/contact/support?utm_source=github&utm_medium=clerk_chrome_extension)。 。 。 .

## 社区

加入我们 [Discord 社区](https://clerk.com/discord) 连接到其他开发者.

## 捐款

我们欢迎所有社区的贡献! 如果你想以任何方式作出贡献,请阅读 [我们的捐款准则](https://github.com/clerk/javascript/blob/main/docs/CONTRIBUTING.md) 财务报告和审定财务报表 [行为守则](https://github.com/clerk/javascript/blob/main/docs/CODE_OF_CONDUCT.md)。 。 。 .

## 警卫

`@clerk/chrome-extension` 遵循安全方面的良好做法,但不能保证100%的安全.

`@clerk/chrome-extension` 提供 **"就这样"** 没有 **保证**. 冒险使用.

_欲了解更多信息并报告安全问题,请参见我们 [安全记录](https://github.com/clerk/javascript/blob/main/docs/SECURITY.md)。 。 。 ._

## 许可证

本项目根据以下规定获得许可证: **麻省理工学院许可证**。 。 。 .

见 [自由主义](https://github.com/clerk/javascript/blob/main/packages/chrome-extension/LICENSE) 更多信息.

## 常见问题

### @clerk/chrome-extension 是什么？

Chrome 扩展名的办事员 SDK

### 如何安装 @clerk/chrome-extension？

在项目目录运行 npm install @clerk/chrome-extension，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.0\.0 \|\| ~19\.0\.3 \|\| ~19\.1\.4 \|\| ~19\.2\.3 \|\| ~19\.3\.0-0）、react-dom（^18\.0\.0 \|\| ~19\.0\.3 \|\| ~19\.1\.4 \|\| ~19\.2\.3 \|\| ~19\.3\.0-0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clerk/chrome-extension 支持 TypeScript 吗？

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

### @clerk/chrome-extension 支持 ESM 还是 CommonJS？

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

### @clerk/chrome-extension 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.9\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @clerk/chrome-extension 可以商用吗？

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

### @clerk/chrome-extension 的下载量有多少？

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

### @clerk/chrome-extension 还在维护吗？

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