@formbricks/js

中文文档
5.3.0发布于 2026/11/13MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 14.9万

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

中文使用文档
文档目录4 节
  1. 什么是福布瑞克斯吗
  2. 如何使用此库
  3. 预选和内容安全政策
  4. 黑暗模式

Formbricks 浏览器 JS 库

npm package MIT License

请看 窗体砖。 。 。 . 具体来说, 快速启动/ 实施细节。 。 。 .

什么是福布瑞克斯吗

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

如何使用此库

  1. 在您的工程中使用 npm 安装 Formbricks 包 :
npm install @formbricks/js
  1. 导入窗体并初始化您主组件中的部件( 例如 App. tsx 或 App.js) :
import formbricks from "@formbricks/js";

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

将工作空间标识替换为工作空间标识。 您可以在 设置检查列表 在 Formbricks 设置中。 如果您想要使用用户身份识别功能, 请查看 详细文件。 。 。 .

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

预选和内容安全政策

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

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 或以后.

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

formbricks.setAppearance("dark");

关于不同框架的更详细指南,请检查我们 框架指南。 。 。 .

版本与发布记录

@formbricks/js 共发布 85 个版本,首次发布于 2023/03/30;过去 12 个月发布了 6 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
5.3.0latest2026/11/132 天前
5.2.02026/11/123 天前
5.1.02026/09/211 个月前
5.0.02026/05/275 个月前
4.4.02026/04/286 个月前
4.3.02025/12/1211 个月前

其他发布通道:beta → 4.0.0-beta.1。

关于 @formbricks/js 的常见问题

@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 和提交记录判断。