# @amplitude/plugin-web-vitals-browser 中文文档

规范地址：https://npmcn.com/package/%40amplitude/plugin-web-vitals-browser/

版本：1\.2\.9
npm 元数据更新时间：2026-11-06T19:43:45.997Z
中文译文更新时间：2026-11-06T19:45:04.713Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40amplitude/plugin-web-vitals-browser
原文对照：https://npmcn.com/package/%40amplitude/plugin-web-vitals-browser/?lang=original
项目主页：https://github.com/amplitude/Amplitude-TypeScript
源码仓库：https://github.com/amplitude/Amplitude-TypeScript

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

- 包体积（解压后）：264 kB，68 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2025-05-30T18:31:42.107Z
- 最新版本发布：2026-11-06T19:43:45.500Z
- 近 30 天下载量：8818015（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：129（近 12 个月 91 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @amplitude/plugin-web-vitals-browser
```

也可以使用：`pnpm add @amplitude/plugin-web-vitals-browser`、`yarn add @amplitude/plugin-web-vitals-browser`、`bun add @amplitude/plugin-web-vitals-browser`

## README

[![](https://static.amplitude.com/brand/amplitude-logo-with-text.svg)](https://amplitude.com/)  

# @amplitude/plugin-web-vitals-浏览器(β)

**这个插件目前位于β中,命名和界面可能会在未来发生变化.**

自动抓取 [网络虚拟](https://www.npmjs.com/package/web-vitals) 度量衡(INP、LCP、FCP、CLS)

## 安装

该软件包发布在国家预防机制登记册上,可用npm和纱线安装.

```sh
# npm
npm install @amplitude/plugin-web-vitals-browser@beta

# yarn
yarn add @amplitude/plugin-web-vitals-browser@beta
```

## 使用量

```typescript
import * as amplitude from '@amplitude/analytics-browser';
import { webVitalsPlugin } from '@amplitude/plugin-web-vitals-browser';
```

### 2\. 说明插件

```typescript
const plugin = webVitalsPlugin();
```

#### 选项

| 名称 | 类型 | 默认 | 说明 |
| --- | --- | --- | --- |
| `reportSoftNav` | `boolean` | `false` | 同时报告软通航的网络要害,而不仅仅是初始的页面负载. |

##### `reportSoftNav`

单页应用程序更新URL和历史而不全页导航,所以默认 Core Web Virtuals仅被测量一次,用于初始的页面负载. 与 `reportSoftNav` 已启用, LCP、FCP、INP、CLS和TTFB 也按下列单位计量: [软导航](https://github.com/WICG/soft-navigations)一个 `[Amplitude] Web Vitals` 事件 按每次导航发送,带有该参数所属的URL的页面属性。 测量的量度 软通航有一个 `navigationType` 联 合 国 `soft-navigation`。 。 。 .

```typescript
const plugin = webVitalsPlugin({ reportSoftNav: true });
```

这需要浏览器支持软导航API(Chromium 151+). 在浏览器没有它, 报告与默认行为相同.

注意启用此功能也会改变初始页面载荷的测量方式:其度量是 一旦第一次软通航,而不是当页被隐藏时,就敲定.

当使用浏览器 SDK 的自动抓取时, 同样的选项可以通过 `autocapture.webVitals`数字 :

```typescript
amplitude.init('API_KEY', {
  autocapture: {
    webVitals: { reportSoftNav: true },
  },
});
```

### 3\. 安装插件到振幅 SDK

```typescript
amplitude.add(plugin);
```

### 4\. 振幅SDK初始化

```typescript
amplitude.init('API_KEY');
```

## 常见问题

### 如何安装 @amplitude/plugin-web-vitals-browser？

在项目目录运行 npm install @amplitude/plugin-web-vitals-browser，或使用 pnpm add / yarn add / bun add。

### @amplitude/plugin-web-vitals-browser 支持 TypeScript 吗？

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

### @amplitude/plugin-web-vitals-browser 支持 ESM 还是 CommonJS？

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

### @amplitude/plugin-web-vitals-browser 可以商用吗？

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

### @amplitude/plugin-web-vitals-browser 的下载量有多少？

根据 npm 官方下载统计，@amplitude/plugin-web-vitals-browser 在 2026/10/06 – 2026/11/04 这 30 天内被下载 8,818,015 次，日均约 293,934 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @amplitude/plugin-web-vitals-browser 还在维护吗？

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