# @formbricks/js 中文文档

规范地址：https://npmcn.com/package/%40formbricks/js/

版本：5\.3\.0
npm 元数据更新时间：2026-11-13T07:29:17.443Z
中文译文更新时间：2026-11-15T08:34:15.902Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：54.2 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2023-03-29T21:31:23.521Z
- 最新版本发布：2026-11-13T07:29:17.108Z
- 近 30 天下载量：148744（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：85（近 12 个月 6 个）

## 中文简介

Formbricks-js允许您将索引连接到Formbricks,显示勘测和触发事件.

## 安装

```sh
npm install @formbricks/js
```

也可以使用：`pnpm add @formbricks/js`、`yarn add @formbricks/js`、`bun add @formbricks/js`

## README

# Formbricks 浏览器 JS 库

[![npm package](https://img.shields.io/npm/v/@formbricks/js?style=flat-square)](https://www.npmjs.com/package/@formbricks/js) [![MIT License](https://img.shields.io/badge/License-MIT-red.svg?style=flat-square)](https://opensource.org/licenses/MIT)

请看 [窗体砖](https://formbricks.com/docs)。 。 。 . 具体来说, [快速启动/ 实施细节](https://formbricks.com/docs/getting-started/quickstart-in-app-survey)。 。 。 .

## 什么是福布瑞克斯吗

Formbricks是你的解决方案 对于产品内部的微观调查, 将会超额增加你的产品体验! 🚀 详情请查看 [formbricks.com (英语)](https://formbricks.com/)。 。 。 .

## 如何使用此库

1.  在您的工程中使用 npm 安装 Formbricks 包 :

```bash
npm install @formbricks/js
```

1.  导入窗体并初始化您主组件中的部件( 例如 App. tsx 或 App.js) :

```javascript
import formbricks from "@formbricks/js";

if (typeof window !== "undefined") {
  formbricks.setup({
    workspaceId: "your-workspace-id",
    appUrl: "https://app.formbricks.com",
  });
}
```

将工作空间标识替换为工作空间标识。 您可以在 **设置检查列表** 在 Formbricks 设置中。 如果您想要使用用户身份识别功能, 请查看 [详细文件](https://formbricks.com/docs/app-surveys/user-identification)。 。 。 .

> `environmentId` 仍然为后向相容性所接受,但已贬值,并将在未来版本被删除。 偏爱 `workspaceId`。 。 。 .

### 预选和内容安全政策

SDK默认预选了勘测渲染器. 如果您的主机应用程序的内容安全 策略块这些预选请求, 在设置时禁用 :

```javascript
formbricks.setup({
  workspaceId: "your-workspace-id",
  appUrl: "https://app.formbricks.com",
  prefetch: false,
});
```

当一次勘测被触发时,渲染器仍然会装载. 选择 `prefetch` 保存默认; `prefetch: true` 明确允许预选。 这需要一个 Formbricks 实例服务 积分为 `prefetch` 支助。 旧实例忽略了选项, 因此更新了 npm 软件包 单靠它不会禁用他们的先验请求 .

### 黑暗模式

调查默认是光明的。 过 `appearance` 改为 `setup()`,或随时修改 `setAppearance()`数字 : `"light"`, (中文(简体) ), `"dark"`,或 `"system"` 以跟踪访问者的浏览器设置。 打开 调查开关到位。 需要Formbricks 6.1 或以后.

```javascript
formbricks.setup({
  workspaceId: "your-workspace-id",
  appUrl: "https://app.formbricks.com",
  appearance: "system",
});

formbricks.setAppearance("dark");
```

关于不同框架的更详细指南,请检查我们 [框架指南](https://formbricks.com/docs/getting-started/framework-guides)。 。 。 .

## 常见问题

### @formbricks/js 是什么？

Formbricks-js允许您将索引连接到Formbricks,显示勘测和触发事件\.

### 如何安装 @formbricks/js？

在项目目录运行 npm install @formbricks/js，或使用 pnpm add / yarn add / bun add。

### @formbricks/js 支持 TypeScript 吗？

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

### @formbricks/js 支持 ESM 还是 CommonJS？

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

### @formbricks/js 可以商用吗？

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

### @formbricks/js 的下载量有多少？

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

### @formbricks/js 还在维护吗？

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