# @flows/js 中文文档

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

版本：1\.24\.2
npm 元数据更新时间：2026-10-26T08:05:15.813Z
中文译文更新时间：2026-11-15T01:01:43.562Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：282 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：5 个
- 首次发布：2024-01-17T06:34:43.839Z
- 最新版本发布：2026-10-26T08:05:15.403Z
- 近 30 天下载量：2426（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：113（近 12 个月 23 个）

## 中文简介

JS SDK - 创造本土产品增长经验

## 安装

```sh
npm install @flows/js
```

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

## README

[![](https://raw.githubusercontent.com/RBND-studio/flows-sdk/refs/heads/main/docs/avatar.png)](https://flows.sh/)

### [流程 JavaScript SDK](https://flows.sh/)

[](https://flows.sh/)

建立产品采纳的更好方式.

[**文档**](https://flows.sh/docs) • 妇女 [**更改日志**](https://flows.sh/changelog) • 妇女 [**实例**](https://flows.sh/examples) • 妇女 [**SDKs 软件**](https://flows.sh/docs/sdk-overview)

## 安装

完整的设置说明,见我们 [快速启动指南](https://flows.sh/docs/quickstart)。 。 。 .

```
npm install @flows/js @flows/js-components
```

`@flows/js` SDK处理流的轻量级嵌入,同时 `@flows/js-components` 提供一组内置组件以快速启动。 或者,你可以 [带自己的组件](https://flows.sh/docs/create-custom-components)。 。 。 .

打电话 `init` 财务报告和审定财务报表 `setupJsComponents` 并传入你的 [组织标识](https://app.flows.sh/r/org/settings) 财务报告和审定财务报表 [环境](https://app.flows.sh/r/org/environments)。 。 。 .

```js
import { init } from "@flows/js";
import { setupJsComponents } from "@flows/js-components";
import * as components from "@flows/js-components/components";
import * as tourComponents from "@flows/js-components/tour-components";

// Depending on your setup, link the CSS, copy-paste it to your codebase, or import it in your JS files
import "@flows/js-components/dist/index.css"

init({
  organizationId: "YOUR_ORGANIZATION_ID", // Find this in Settings > General
  userId: "YOUR_USER_ID", // Identify the user
  environment: "production", // Default environment
});
setupJsComponents({
  components: { ...components },
  tourComponents: { ...tourComponents },
});`
```

添加 `<flows-floating-blocks>` 结尾处 `<body>` 用于处理浮动组件的渲染.

```html
<body>
  <!-- Your app code -->

  <flows-floating-blocks></flows-floating-blocks>
</body>
```

## 特征

迎来"流",构建应用中体验的灵活平台. 专注于你的产品,而不是创造一次性逻辑.

-   积累强大的应用经验来推动产品增长
-   创建调查并收集反馈
-   将组件直接嵌入您的应用程序
-   创建登机、产品采用、应用信息、成长实验等
-   带上自己的UI组件或使用 Flows 内置组件

拜访我们 [网站](https://flows.sh/) 学习更多关于"流"

## 免费开始

最快和最可靠的 开始与流是 [免费报名](https://app.flows.sh/signup)您的第一个100 MTU(月度跟踪用户)每月免费。 看我们的 [定价](https://flows.sh/pricing) 更多细节.

## 捐款

我们贡献大小 如果您有任何改进想法,请提交问题或创建拉力请求.

* * *

创建于 [rbnd.studio (英语)](https://rbnd.studio/)。 。 。 .

## 常见问题

### @flows/js 是什么？

JS SDK - 创造本土产品增长经验

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

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

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

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

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

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

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

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

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

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

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

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