# @barbapapazes/plausible-tracker 中文文档

规范地址：https://npmcn.com/package/%40barbapapazes/plausible-tracker/

版本：0\.5\.6
npm 元数据更新时间：2024-11-20T15:19:11.431Z
中文译文更新时间：2026-11-07T16:52:39.510Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：46.8 kB，23 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2024-02-01T12:52:24.160Z
- 最新版本发布：2024-11-20T15:19:11.277Z
- 近 30 天下载量：13855（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

前端跟踪器与 Plausible 分析器交互

## 安装

```sh
npm install @barbapapazes/plausible-tracker
```

也可以使用：`pnpm add @barbapapazes/plausible-tracker`、`yarn add @barbapapazes/plausible-tracker`、`bun add @barbapapazes/plausible-tracker`

## README

# 活性分析跟踪器

[![npm version](https://img.shields.io/npm/v/@barbapapazes/plausible-tracker?style=flat&colorA=18181B&colorB=0ea5e9)](https://npmjs.com/package/@barbapapazes/plausible-tracker) [![npm downloads](https://img.shields.io/npm/dm/@barbapapazes/plausible-tracker?style=flat&colorA=18181B&colorB=0ea5e9)](https://npmjs.com/package/@barbapapazes/plausible-tracker)

重写 [可信跟踪器](https://github.com/plausible/plausible-tracker) 并铭记可扩展性和未来的特点.

> \[大 这不是一个临时替代.

## 为什么重写?

来自柏拉图克球队的原追踪员在两年多的时间里没有收到更新.

从那时起 [脚本跟踪器](https://plausible.io/docs/script-extensions) npm 软件包已经进化,但是没有。 例如,不支持文件倒闭和收入跟踪.

此外,一些严重的问题被打开,没有得到解决。 外出追踪是打破 `target="_blank"` 例如,属性.

## 使用量

首先,安装软件包:

```bash
npm install @barbapapazes/plausible-tracker
```

那么,用你的代码:

```ts
import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'

const plausible = createPlausibleTracker()

plausible.trackPageview() // Track a page view
plausible.trackEvent('signup') // Track a custom event
```

> \[注\] 这个 `trackPageview` 是一个包裹周围 `trackEvent` 与 `pageview` 事件名称.

第一项论据是: `trackPageview` 和第二个 `trackEvent` 是一个接受道具、数据和在事件发送后触发的回调对象.

道具与提供 [正式可打印脚本](https://plausible.io/docs/custom-props/for-custom-events#2-using-the-manual-method)。 。 。 .

数据允许您覆盖一些值,如 `url`, (中文(简体) ), `referrer` 财务报告和审定财务报表 `deviceWidth`。 。 。 .

```ts
plausible.trackEvent('signup', { props: { variation: 'button A' }, callback: () => console.log('sended') }) // Track a custom event with a custom prop with a callback
```

此核心跟踪器是最小的, 不包括任何扩展 。 这样你就可以轻松地编出它来避免运送你不需要的代码.

## 扩展

扩展是核心跟踪器中没有包含的特性.

> \[注\] 扩展会有助于将软件包与正式脚本保持最新.

当前扩展 :

-   [自动页面查看跟踪](https://plausible.io/docs/auto-pageview-tracking)
-   [输出链接点击跟踪](https://plausible.io/docs/outbound-link-click-tracking)
-   [文件下载跟踪](https://plausible.io/docs/file-downloads-tracking)

### 自动页面查看跟踪

```ts
import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoPageviews } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useAutoPageviews(plausible)

install()

// At any time, you can stop the auto pageview tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })
// Now, every page view will include the prop `variation: 'button A'`
```

### 输出链接点击跟踪

```ts
import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoOutboundTracking } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useOutboundLinkTracking(plausible)

install()

// At any time, you can stop the outbound link tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })
```

### 文件下载跟踪

```ts
import { createPlausibleTracker } from '@barbapapazes/plausible-tracker'
import { useAutoFileDownloadsTracking } from '@barbapapazes/plausible-tracker/extensions'

const plausible = createPlausibleTracker()

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: [] }) // You can pass the file types to track. For example: ['pdf', 'zip']

install()

// At any time, you can stop the file downloads tracking
cleanup()

// You can also set the page options
setEventOptions({ props: { variation: 'button A' } })
```

> \[大 默认情况下,文件下载不会跟踪任何文件类型. 您需要通过文件类型来跟踪 .

软件包导出 `defaultFileTypes` 是最常用文件类型的数组 [和正式剧本一样](https://plausible.io/docs/file-downloads-tracking#which-file-types-are-tracked)。 。 。 .

```ts
import { defaultFileTypes } from '@barbapapazes/plausible-tracker/extensions'

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: defaultFileTypes })
```

这使得您可以轻松自定义文件类型以跟踪 :

```ts
import { defaultFileTypes } from '@barbapapazes/plausible-tracker/extensions'

const { install, cleanup, setEventOptions } = useFileDownloadsTracking(plausible, { fileTypes: [...defaultFileTypes, 'svg'] })
```

## 贡献

捐款非常受欢迎。 我不是柏拉图球队的一员, 我在空闲时间这样做

-   叉子存储器
-   安装依赖性 : `pnpm install`
-   构建工程 : `pnpm build`
-   使用游乐场测试您的更改 : `cd playground && pnpm dev`

谢谢你的帮助!

## 许可证

[麻省理工学院](https://npmcn.com/package/%40barbapapazes/plausible-tracker/LICENSE) © [巴巴多斯](https://github.com/barbapapazes)

此套件并不附属于"活泼分析",而是被他们的作品所启发. [可信跟踪器](https://github.com/plausible/plausible-tracker) [活性分析跟踪器](https://github.com/plausible/analytics/tree/master/tracker)

## 常见问题

### @barbapapazes/plausible-tracker 是什么？

前端跟踪器与 Plausible 分析器交互

### 如何安装 @barbapapazes/plausible-tracker？

在项目目录运行 npm install @barbapapazes/plausible-tracker，或使用 pnpm add / yarn add / bun add。

### @barbapapazes/plausible-tracker 支持 TypeScript 吗？

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

### @barbapapazes/plausible-tracker 支持 ESM 还是 CommonJS？

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

### @barbapapazes/plausible-tracker 可以商用吗？

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

### @barbapapazes/plausible-tracker 的下载量有多少？

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

### @barbapapazes/plausible-tracker 还在维护吗？

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